Back to bounties
Open•Posted Dec 29, 2025
Write comprehensive API documentation for REST endpoints
Writing
Intermediate
Due Jan 3, 2026
api-documentationrest-apitechnical-writingmarkdownopenapi
Description
I need professional API documentation written for a REST API with 12 endpoints. The API handles user authentication, profile management, and data retrieval. Current situation: - API endpoints exist and are functional - No documentation exists currently - Developers are struggling to integrate Expected deliverable: - Complete API documentation in Markdown format - Include request/response examples for each endpoint - Add authentication flow documentation - Include error code reference - Format suitable for GitHub README or API docs site The documentation should be clear enough for developers to integrate without additional support. Please use OpenAPI/Swagger format if possible, or provide well-structured Markdown with code examples.
Acceptance Criteria
1. All 12 API endpoints are documented with: - HTTP method and endpoint path - Request parameters (query, path, body) - Request body schema/example - Response schema/example - Status codes and error responses 2. Authentication section explains: - How to obtain API key - How to include it in requests - Token refresh flow 3. Documentation is formatted in Markdown 4. Code examples are provided for at least 3 different endpoints 5. Error handling section lists all possible error codes 6. Documentation is reviewed and free of typos/grammar errors