Carte is a simple Jekyll based documentation website for APIs. It is designed as a boilerplate to build your own documentation and is heavily inspired from Swagger and I/O docs. Fork it, add specifications for your APIs calls and customize the theme. Go ahead, see if we care.
We built Carte because the existing options (Swagger and the likes) were trying to do too much and did not match our needs:
Most of our API calls are sending JSON objects, as opposed to a series of parameters,
Being able to query the real API is nice, but running anything but GET calls can get tricky ("What do you mean I deleted my stuff? I was just trying out the API calls!"),
Overall, setting up a separate server for what really requires a good static documentation seemed overkill.
The future of API design: The orchestration layer
A key concept here is that we have put the API team in the position of gathering the data in a generic, reusable way while putting the device teams in the position of owning the data formatting and delivery. After all, the formatting needs evolve in concert with the UI changes so putting that effort in the hands of those closest to the changes eliminates additional steps.
Bookmarks on this page are managed by an admin user. 