Tuesday, 17 March 2020

Introduction to Swagger

Overview
a.   Swagger is used to design, document and generate code for the APIs of the application.
b.   Swagger API definitions are compliant to the Open API Specification (OAS).

What is Open API Specification?
OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.

Swagger Toolbox has below tools in its archery.
a.   Swagger Editor: Used to build API definition files. Go through the link 'http://editor.swagger.io/' to get a feeling of Swagger Editor.

b.   Swagger UI: Generate documentation from API definitions, it hosts APIs generated from API definition files. Go through the link 'http://petstore.swagger.io' to get a feeling of how swagger UI looks like.


c.    Swagger Codegen: Used to build client SDKs from API definitions. In Swagger editor, you can see Generate Server, Generate client tabs, these are used to generate client and server stubs.

d.   Swagger hub

e.   Swagger Inspector


Previous                                                    Next                                                    Home

No comments:

Post a Comment