February 2, 2022

Swagger OpenAPI and YAML

Input: Yaml official website

https://support.smartbear.com/swaggerhub/docs/tutorials/openapi-3-tutorial.html

Install Swagger editor:

https://github.com/swagger-api/swagger-editor/blob/master/README.md

https://editor.swagger.io/

OpenAPI - спецификация

Swagger - инструментарий использующий спецификацию OpenAPI

Swagger allows you to describe the structure of your APIs so that machines can read them. The ability of APIs to describe their own structure is the root of all awesomeness in Swagger. Why is it so great? Well, by reading your API's structure, we can automatically build beautiful and interactive API documentation. API Development for Everyone.

  • Allow machines/tools to integrate with API
  • Allow humans to implement API code
  • Allow humans to read and generate API documentation and test cases

The OpenAPI Initiative (support specification) provides an open-source, technical community, within which industry participants may easily contribute to building a vendor-neutral, open specification for providing technical metadata for REST APIs.

Swagger - set of tools build around implementation of the OpenAPI specification, tjere are few tools like UI, editor, SwaggerHub, etc.

What's New? BASIC:
Improved reusability
Parameter changes
Improved examples
Content negotiation support

ADVANCED
Support for describing callbacks
Links to express relationships between
operations
Enhanced security definitions

Difference between OpenAPI 2.0 and 3.0

Parameters
Query (users?id=3)
Path (users/keshav.vasudevan)
Header (X-customheader=23)
Cookies (cookie: debug=0)


RequestBody
Further serialization supported by defining media types

SwaggerHub tutorial