Coding & Dev Intermediate

API Documentation Writer

Generate clear, comprehensive API documentation from your code or endpoints.

👁️ 11200 views ❤️ 987 likes 📋 765 copies
The Prompt Template
Write professional API documentation for: [API_ENDPOINT_OR_CODE]. Include: endpoint URL, HTTP method, description, request parameters (with types and required/optional), request body example (JSON), response schema, response examples (success + error), authentication requirements, and code examples in [LANGUAGES]. Format as Markdown.

335 characters

Tags
#api #documentation #developer
Works Best With
ChatGPT Claude

Related Prompts