OpenStack API-WG defined Swagger as a standard API documentation way. In the external world also, Open API initiative is defining Swagger as a standard API specification. So Swagger is a standard way in the world now.
By defining Swagger as a standard way, we provide guidelines for API documentation for all OpenStack projects asa community. Then projects use common tooling, consistent outlines, and study exemplary examples.In addition, Swagger is not only for API documentation but also for client side implementation. By getting Swagger data via REST API from server side, clients can know available APIs and usage of these APIs.That is great for the OpenStack interoperability.
On Nova and Magnum sides, we are planing Swagger implementation as a next feature. On the documentation side, we are implementing a tool "fairy-slipper" for migrating current API documentation to Swagger format.
This session provides the overview of Swagger, how to apply Swagger to each project, and merit for clients.
Attendees expect to learn overview of Swagger, how to apply Swagger to each project based on future design of both Nova and Magnum, and what is actual merit for client side based on Magnum-UI in this session.Technically, how to adopt Swagger varies across web frameworks and this session covers two different frameworks, Nova home-made one and Magnum Pecan/WSME as examples. So by showing both cases on this presentation, attendees can know wide adoption ways for matching their own projects.