Watch Us Write Our New API Documentation
James Yu, a co-founder of Parse, said:
Documentation is a layered beast.
Truer words are rarely spoken. And writing blog posts about how to write API documentation is almost as old as the idea of RESTful APIs (one we particularly appreciate is Braintree’s story.) While we’re very big fans of Swagger, sometimes interacting with an API isn’t enough to understand an API — so we have spent the last couple of months thinking about how to make our API documentation more successful.
We’re not done migrating all of our documentation to Slate, but that’s part of the fun. Last month, Mailjet talked about open sourcing their API documentation and we think that’s absolutely brilliant. So we’re open sourcing ours!
If you’d like to see the work in process, we have it up at https://bestbuyapis.github.io/api-documentation/. And if you’d like to get involved (or just watch us get it finished), you can follow along at https://github.com/BestBuyAPIs/api-documentation.
Isn’t open source awesome?