April 25-29, 2016

Event Details

Please note: All times listed below are in Central Time Zone

OpenAPI as a Standard - A New Way Forward for API Documentation, Design and Tool

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.

What can I expect to learn?

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.

Monday, April 25, 3:40pm-4:20pm (8:40pm - 9:20pm UTC)
Difficulty Level: Beginner
Ken'ichi has joined into OpenStack community since 2012, and he is working for OpenStack quality mainly. He has fixed many bugs as an OpenStack community member. Now he is a PTL of OpenStack QA project and a core developer of Compute(Nova).   FULL PROFILE
NEC Solution Inovators
Motohiro is software engineer from NEC. He has been working on projects related to Openstack and Cloud Foundry. He is interested in cloud application deployment. Currently He is involeved in the project which uses kubernetes on OpenStack private cloud. He was Magnum core reviewer from 12/24/14 to 04/31/17. FULL PROFILE
Anne Gentle works in open source projects with the OpenStack project at Cisco, using open source techniques for API design, developer support, and documentation. She governs projects by serving as an elected member of the OpenStack Technical Committee for more than 30 projects written in Python across hundreds of git repositories. She advocates for cloud users and administrators by providing... FULL PROFILE
Alex Xu has joined into Openstack from Grizzly, and he is working for Openstack Neutron and Nova. He is a core developer of Nova now. FULL PROFILE