Discover more from API Documentation
API Documentation - #02
Highlights: Free technical writing courses, Communicating warning information in HTTP APIs, How to manage documentation as code.
🎓Free technical writing courses - Google released an education platform to train engineers on technical writing. The portal comes with two modules to learn about planning and authoring technical documents.
📹 Communicating warning information in HTTP APIs - Andre Cedik summarizes how well-known APIs are returning errors. To make "soft error handling" easier for future API development, he also proposes a draft RFC for communicating warning information in HTTP APIs.
📝 REST API: Sorting, filtering, and pagination - Tania Rascia documented how to create pagination, filtering, and sorting endpoints. The article highlights the key points to take into account when designing an API.
Docs as Code
📝 GitHub CLI 1.0 is now available - GitHub released the 1.0 version of their CLI. The command-line tool allows you to run your entire GitHub workflow from the terminal, from issues to releases.