Slides from the London Technical Evangelism meet up, where we were discussing different approaches to documenting API's to keep it simple for developers
19. Thoughts:
Allows you to directly test calls in the interface
Loads of community language integrations
Great for 'sandboxing', not as quick for documentation
20. Lots of information about the api calls, but a little hidden
So perhaps not for us.
24. It's great!
Inspired by the Stripe & Braintree documentation
Efficient layout
Quick to generate
Open Source
Highly customisable
25. It gives you:
An index of endpoints and space for explanations
Code required for the call
Response from the server
These are three things I definitely like to find in docs!
30. Advantages
Time with the community!
Documentation less likely to stagnate
git diff is a wonderful thing
Fully integrated into Github workflow, with PR's and forks
Integrate update alerts on platforms like Slack to keep you on your
toes