Documenting API endpoints
I'm giving an API documentation workshop in San Francisco, California, on November 19, 2019. Check it out on EventBrite and register today to receive a $100 early bird discount.
Reference documentation for API endpoints consists of five general sections: resource descriptions, endpoints and methods, parameters, sample requests, and sample responses and schemas. To document the reference endpoints of an API, provide detailed information for each of these sections.
49/146 pages complete. Only 97 more pages to go.
Want to buy me lunch? Click the Donate button below to donate any amount through Paypal.