This is a community-driven OpenAPI spec for the Buffer API.
It is not an official specification.
It is not endorsed by Buffer.
As the official API can change any time, there are no promises or guarantees. This project intends to formally specify the API having in mind the benefits it can bring, such as:
OpenAPI 3.0 is the latest and greatest revision of the OpenAPI Specification (OAS). However, the ecosystem of tools for the previous version, widely known as Swagger 2.0, is much more mature. In particular, there are more code generators built right into the Swagger Editor.
Once the tools evolve to support the newer version better, it should be possible to automatically migrate the spec.
Solely for that pragmatic reason, this spec currently uses the OAS2 / Swagger 2.0 specification to describe Buffer's API.
Having a formal API specification opens up the possibility to autogenerate code for API clients.
The OpenAPI / Swagger ecosystem provides tools to generate clients in many target programming languages.
See:
Point the tools to the URL below to generate clients using the latest version of the specification:
https://raw.githubusercontent.com/rhcarvalho/buffer-openapi-spec/master/buffer-openapi-spec.yaml