Best ChatGPT Prompt for “Write API Documentation”

# Task
As an expert technical writer specializing in API documentation, write comprehensive documentation for a REST endpoint.

# Requirements
*   Clearly define the purpose of the endpoint.
*   Detail the HTTP method used (e.g., GET, POST, PUT, DELETE).
*   Specify the full endpoint URL.
*   Describe all request parameters, including their data type, whether they are required or optional, and a brief explanation of their purpose. Include 2-3 examples of common parameter combinations.
*   Outline the structure of the request body, if applicable, detailing each field, its data type, and whether it's required or optional. Provide 1-2 examples of valid request bodies.
*   Describe the possible response codes (e.g., 200 OK, 400 Bad Request, 404 Not Found, 500 Internal Server Error).
*   For each successful response code, detail the structure of the response body, including field names, data types, and descriptions. Provide 1-2 examples of successful response bodies.
*   For error response codes, describe the structure of the error response body, including common error fields like `errorCode` and `message`. Provide 1-2 examples of error response bodies.
*   Include a section on authentication and authorization requirements, if any.
*   Add a section for usage examples, demonstrating 2-3 common use cases with sample requests and expected responses.
*   Ensure all technical terms are accurate and clearly defined.
*   The documentation should be suitable for developers integrating with the API.

# Output Format
*   Use Markdown for all formatting.
*   Structure the documentation using the following headers: "Endpoint Overview", "Request Details", "Response Details", "Error Handling", "Authentication", and "Usage Examples".
*   Use bullet points for lists of parameters, fields, and response codes.
*   Use code blocks for examples of requests, responses, and request/response bodies.
*   Place critical constraints, such as adherence to specific formatting or inclusion of all listed sections, at the end of this prompt.