From 518a4bb6881ecd7370f00af4292d2b47cd4f6d87 Mon Sep 17 00:00:00 2001 From: alkeshattal Date: Wed, 16 Jan 2019 23:47:59 +0100 Subject: [PATCH] Added points related to API Specification (#32719) --- guide/english/rest-api/index.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/guide/english/rest-api/index.md b/guide/english/rest-api/index.md index 7e116809a0..eebe5eda77 100644 --- a/guide/english/rest-api/index.md +++ b/guide/english/rest-api/index.md @@ -148,11 +148,20 @@ REST APIs not only support `xml`, but also support `html`, `json` and `csv`, amo ### REST API Development Environment and Testing: Postman is widely used and famous for manual and automated REST/RESTful API Tests. + Link: [Get Postman](https://www.getpostman.com/) A detailed explanation has been given on Quick Code blog on how to use Postman for the best usage: + [Top Tutorials To Learn POSTMAN For REST API Testing](https://medium.com/quick-code/top-tutorials-to-learn-postman-for-rest-api-testing-3bdf9788e0ba) +### API Specification +Having a clear and precise API specification is very important. + +The most popular standard for the API specification is [OpenAPI Specification.](https://github.com/OAI/OpenAPI-Specification) + +[Swagger Tool](https://swagger.io/) is commonly used for describing the APIs. + #### More Information * [How to Design Great APIs - Parse Developer Day 2013](https://www.youtube.com/watch?v=qCdpTji8nxo) * [The never-ending REST API design debate by Guillaume Laforge](https://www.youtube.com/watch?v=48azd2VqtP0)