This document introduces Swagger, an open-source framework for describing, producing, consuming, and visualizing RESTful APIs. It provides a specification for describing APIs in a machine-readable format. Swagger allows automatically generating documentation from code and enabling tooling around REST APIs. The document discusses Swagger specifications, how to list and view API details, integration with various programming languages and frameworks, development and deployment processes, and alternatives to Swagger.
6. Documentation
• No standard
• Ad-hoc attributes
• Managed manually
• Not up to date
• …..
http://www.imagineyourreality.com/business-coaching/documentation.html
10. Swagger is…
• producing
• consuming
• visualizing
RESTful APIs
A framework
for
• describing
• documenting
RESTful APIs
A specification
for
Technology Methodology
11. The Swagger Specification
It’s a spec!
• JSON to specify metadata
• JSON to specify API structure
• JSON schema for the model
specification
• Machine readable
• Language agnostic
12. Agenda
• Introduction
• Deep Dive
• The technology
• Swagger is not
• Alternatives
• Dev process
• Deployment process
• References
27. • Does not support multiple API versions
• Does not tell how to write the API
–Delete an object by HTTP DELETE or via
HTTP GET with query param
• Is not trying to solve all problems for all
APIs