Open API (aka Swagger) - DDD by Night May 2020
Download as PPTX, PDF•1 like•269 views
The document provides an overview of the OpenAPI Specification (OAS), which is a standard for defining REST APIs that enables easier interaction and understanding of service capabilities. It highlights resources and tools for API design, development, testing, documentation, and publishing, including Stoplight Studio, Swagger Editor, and Postman. The document emphasizes the role of OAS in reducing guesswork and streamlining API implementation.
Open API (aka Swagger) - DDD by Night May 2020
- 1. OpenAPI PRATIK KHASNABIS CLOUD SOLUTION ARCHITECT @SOFTVEDA
- 2. API Lifecycle OpenAPI API Design API Develop API Test API Document API Publish API Consume
- 3. OpenAPI OpenAPI Specification (OAS): “The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for REST APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interface descriptions have done for lower-level programming, the OpenAPI Specification removes guesswork in calling a service.” http://spec.openapis.org/oas/v3.0.3 Started as Swagger by SmartBear and donated to OpenAPI Initiative (OAI)
- 4. Structure
- 5. Metadata
- 7. Components
- 8. API Design VS Code: https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi Stoplight Studio: https://stoplight.io Swagger Editor: https://editor.swagger.io
- 9. API Develop Swashbuckle: https://github.com/domaindrivendev/Swashbuckle.AspNetCore Spectral: https://marketplace.visualstudio.com/items?itemName=stoplight.spectral
- 10. API Test Postman: https://www.postman.com Import OpenAPI Spec as a API Collection.
- 11. API Document Swashbuckle.AspNetCore: https://github.com/domaindrivendev/Swashbuckle.AspNetCore ReDoc: https://redocly.github.io/redoc/
- 12. API Publish Azure API Management AWS Apigee
- 13. API Consume Visual Studio Connected Service OpenAPI CLI Generator