From dd2a73f0c6522e3b4c925d00b9117bf5e150c56c Mon Sep 17 00:00:00 2001 From: Bruno Scheufler Date: Sun, 24 Mar 2019 16:48:02 +0100 Subject: [PATCH] rephrased titles --- README.md | 2 +- sections/errorhandling/documentingusingswagger.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 694d2921..48d3415d 100644 --- a/README.md +++ b/README.md @@ -154,7 +154,7 @@ Read in a different language: [![CN](/assets/flags/CN.png)**CN**](/README.chines

-## ![✔] 2.5 Document RESTful API errors using Swagger +## ![✔] 2.5 Document API errors using Swagger or GraphQL **TL;DR:** Let your API callers know which errors might come in return so they can handle these thoughtfully without crashing. For RESTful APIs, this is usually done with documentation frameworks like Swagger. If you're using GraphQL, you can utilize your schema and comments as well. diff --git a/sections/errorhandling/documentingusingswagger.md b/sections/errorhandling/documentingusingswagger.md index ebf20136..b71cfead 100644 --- a/sections/errorhandling/documentingusingswagger.md +++ b/sections/errorhandling/documentingusingswagger.md @@ -1,4 +1,4 @@ -# Document RESTful API errors using Swagger +# Document API errors using Swagger or GraphQL ### One Paragraph Explainer