News for hackers. Stuff that matters.

A comment on Ask HN: What are examples of good dev docs?.

Re:Ask HN: What are examples of good dev docs? by jdbowman on Monday August 31, 2020 @05:47AM (#24329826)
What sort of API is it? Web-based (as in REST or GraphQL)? Or software libraries? Curious the language, in that case...
[ Parent | on HN ]
Re:Ask HN: What are examples of good dev docs? by ibn-python on Monday August 31, 2020 @04:21PM (#24335533)
REST
[ Parent | on HN ]
Re:Ask HN: What are examples of good dev docs? by jdbowman on Monday August 31, 2020 @07:18PM (#24336864)
A few that impress me: - Github: https://docs.github.com/en/rest/guides/getting-started-with-... - Twilio: https://www.twilio.com/docs/usage/api - Stripe: https://stripe.com/docs/api

You may also appreciate reading Swagger's tips: https://swagger.io/blog/api-documentation/best-practices-in-... and reading up on Swagger in general.

[ Parent | on HN ]