A response is defined by an HTTP status code, description and optional schema (a data model for the response body, if any). Next, we need to describe possible responses for the API call. This is one of the reasons why OpenAPI is so popular among API developers. This simple format is human-readable, machine-readable and self-explanatory.

SwaggerHub Editor uses YAML, but you can import and download both YAML and JSON.Ī sample OpenAPI 3.0 specification (in the YAML format) looks like this: openapi: 3.0.0 OpenAPI definitions can be written in YAML or JSON. Swagger UI Swagger UI, a part of Swagger, is an open source tool that generates a web page that documents the APIs generated by the Swagger specification.This UI presentation of the APIs is user. SwaggerHub supports OpenAPI 3.0 (the latest version) and OpenAPI 2.0. OpenAPI Specification has undergone several versions since the original release. Install Swagger UI, run: docker pull swaggerapi/swagger-ui Run Swagger UI: docker run -p 8000:8080 swaggerapi/swagger-ui. Download docker here, follow the instructions according to your operating system.

OpenAPI lets you describe your entire API, including the available endpoints, operations, request and response formats, supported authentication methods, support contacts and other information. We will install Swagger UI & Swagger Editor using docker. It is equally suitable both for designing new APIs and for documenting your existing APIs. OpenAPI Specification (formerly known as Swagger Specification) is an API description format for REST APIs.

Swagger editor docker start