Module 6: Documenting API Requests and Responses (2 hours)
- Methods: GET, POST, PUT, DELETE
- Hands-on: Documenting a sample API in JSON
Module 7: Documenting API Errors (1.5 hours)
- Common error codes (4xx, 5xx)
- Hands-on: Documenting error messages
Module 8: Real-world Case Study: API Documentation (1.5 hours)
- Analyzing major platforms (e.g., Google, Stripe)
- Best practices and critiques
Module 9: Creating API Reference Guides (1.5 hours)
- Writing API reference documents with examples
- Hands-on: Create an API reference guide
Module 10: Final Project and Review (1.5 hours)
- Documenting a full API (requests, responses, errors)
- Peer review and feedback