Cloud Foundry Summit 2016

The Open API Specification (née Swagger 2.0) is a comprehensive language for describing Web APIs (e.g., REST) using a JSON. Using the description of a Web API one can easily generate all types of artifacts (docs, clients, proxies, and so on) that are useful to consumers, developers, and maintainers of the API.  

CF-Swagger is an incubation project in CloudFoundry where we have applied Swagger to various CF APIs in order to generate value. For instance, by having a Swagger description of the Service Broker APIs we are able to generate a Golang Test Compatibility Kit (TCK) that makes it easy for a CF service administrator to vet whether a service broker conforms to a particular version of the service broker API. 

We have also described various other CF APIs using Swagger with the goal to allowing specific useful tasks. In this talk we will give a complete overview of the various CF APIs we have swaggerized, along with some of the useful consequences of the description. We will also discuss general directions of the project along with other potential applications by looking at how the Swagger community is currently taking advantage of APIs' descriptions.