Category: Unconference Session
18 May 2015, unconf session on RESTful APIs.
FYI, i’ve shared my notes – and others in the session will do the same:
Some user introls
Oldschool API ref
Autodesk — global API
Mike – Forgerock, showed docs
Steven API tech writer, square
Build as they go
Seems to require humans to write compelling API examples
Ruby, Python, curl, C+, objective C, etc.
Some arbitrarily say “we just use curl, anything else, YMMV”
Python examples — most “pseudo-codish programming language”
Square example: https://docs.connect.squareup.com/#httplibrary
Script that checks every endpoint every hour
explicit — how you auth — different for everyone — token in URI / header
Discussion on versioning
— not just a modified version of the same doc, especially when endpoints change
Square works with a simplifedish version of DITA for API docs
1 page per service?