Swagger: Difference between revisions
Jump to navigation
Jump to search
| (7 intermediate revisions by the same user not shown) | |||
| Line 9: | Line 9: | ||
* [[REST and Hypermedia]] | * [[REST and Hypermedia]] | ||
* [[OpenAPI]] | * [[OpenAPI]], [[OpenAPI Specification]] | ||
* [[API]] | * [[API]] | ||
* [[JAX-RS]] | * [[JAX-RS]] | ||
* [[RAML]] | |||
* [[json:api]] | |||
=Overview= | =Overview= | ||
Swagger is an API framework, consisting of a set of open-source tools built around the [[OpenAPI]] specification that can help you design, build, document and consume REST APIs. | Swagger is an API framework, consisting of a set of open-source tools built around the [[OpenAPI]] specification that can help you design, build, document and consume REST APIs. | ||
=Concepts= | |||
{{Internal|Swagger Concepts|Swagger Concepts}} | |||
=Tools= | =Tools= | ||
* [[Swagger API Tools]] | |||
* [[Swagger Editor]] | * [[Swagger Editor]] | ||
| Line 25: | Line 33: | ||
* [[Swagger Inflector]] | * [[Swagger Inflector]] | ||
* [[Swagger Inspector]] | * [[Swagger Inspector]] | ||
* [[Amazon API Gateway Importer]] | |||
=API Documentation= | =API Documentation= | ||
Latest revision as of 23:05, 25 March 2019
External
- https://swagger.io
- OpenAPI Swagger Specification https://swagger.io/specification/
- Tools and Integrations: https://swagger.io/tools/open-source/open-source-integrations/
- Build, Document, and Deploy Your API with Swagger, Amazon API Gateway and Lambda https://swagger.io/blog/api-development/swagger-amazon-api-gateway-and-lambda/
Internal
Overview
Swagger is an API framework, consisting of a set of open-source tools built around the OpenAPI specification that can help you design, build, document and consume REST APIs.
Concepts
Tools
- Swagger Editor
- Swagger UI
- Swagger Codegen
- SwaggerHub
- Swagger Inflector
- Swagger Inspector
- Amazon API Gateway Importer
API Documentation
API Documentation vs. Swagger-generated Specification File
In general, the terms "API Documentation" and the Swagger specification are used interchangeably.