Overview
This prompt guides API documentation writers in creating clear and structured documentation for developers. Developers will benefit by gaining easy access to comprehensive and understandable API information for effective implementation.
Prompt Overview
Purpose: This documentation provides a comprehensive guide for developers to effectively use the API.
Audience: The intended audience includes software developers and engineers seeking to integrate the API into their applications.
Distinctive Feature: The API offers clear examples and structured endpoints for seamless implementation and troubleshooting.
Outcome: Developers will gain the knowledge needed to successfully authenticate and utilize the API’s features.
Quick Specs
- Media: Text
- Use case: Analysis, Content Creation, Enhancement
- Industry: Development Tools & DevOps, General Business Operations, Property Development
- Techniques: Role/Persona Prompting, Structured Output, Style Guide Adherence
- Models: Claude 3.5 Sonnet, Gemini 2.0 Flash, GPT-4o, Llama 3.1 70B
- Estimated time: 15-30 minutes
- Skill level: Advanced
Variables to Fill
- [API_NAME] – Api Name
- [BASE_URL] – Base Url
- [AUTH_TYPE] – Auth Type
- [AUTH_LOCATION] – Auth Location
- [AUTH_PARAM_NAME] – Auth Param Name
- [AUTH_EXAMPLE] – Auth Example
- [API overview and purpose] – Api Overview And Purpose
- [ENDPOINT_1_URL] – Endpoint 1 Url
- [ENDPOINT_1_METHOD] – Endpoint 1 Method
- [ENDPOINT_1_DESCRIPTION] – Endpoint 1 Description
- [PARAM_1_NAME] – Param 1 Name
- [PARAM_1_TYPE] – Param 1 Type
- [PARAM_1_REQUIRED] – Param 1 Required
- [PARAM_1_DESCRIPTION] – Param 1 Description
- [PARAM_1_EXAMPLE] – Param 1 Example
- [RESPONSE_1_FORMAT] – Response 1 Format
- [RESPONSE_1_EXAMPLE] – Response 1 Example
- [ENDPOINT_2_URL] – Endpoint 2 Url
- [ENDPOINT_2_METHOD] – Endpoint 2 Method
- [ENDPOINT_2_DESCRIPTION] – Endpoint 2 Description
- [PARAM_2_NAME] – Param 2 Name
- [PARAM_2_TYPE] – Param 2 Type
- [PARAM_2_REQUIRED] – Param 2 Required
- [PARAM_2_DESCRIPTION] – Param 2 Description
- [PARAM_2_EXAMPLE] – Param 2 Example
- [REQUEST_2_FORMAT] – Request 2 Format
- [REQUEST_2_EXAMPLE] – Request 2 Example
- [RESPONSE_2_FORMAT] – Response 2 Format
- [RESPONSE_2_EXAMPLE] – Response 2 Example
- [ERROR_CODE_1] – Error Code 1
- [ERROR_CODE_1_DESCRIPTION] – Error Code 1 Description
- [TROUBLESHOOTING_TIPS] – Troubleshooting Tips
- [Any other relevant information] – Any Other Relevant Information
Example Variables Block
- [API_NAME]: WeatherAPI
- [BASE_URL]: https://api.weather.com
- [AUTH_TYPE]: API Key
- [AUTH_LOCATION]: Header
- [AUTH_PARAM_NAME]: Authorization
- [AUTH_EXAMPLE]: Bearer your_api_key
- [API overview and purpose]: Provides weather data for locations.
- [ENDPOINT_1_URL]: /current
- [ENDPOINT_1_METHOD]: GET
- [ENDPOINT_1_DESCRIPTION]: Fetches current weather data.
- [PARAM_1_NAME]: location
- [PARAM_1_TYPE]: string
- [PARAM_1_REQUIRED]: true
- [PARAM_1_DESCRIPTION]: City name or coordinates.
- [PARAM_1_EXAMPLE]: New York
- [RESPONSE_1_FORMAT]: application/json
- [RESPONSE_1_EXAMPLE]: {"temperature": 75, "condition": "Sunny"}
- [ENDPOINT_2_URL]: /forecast
- [ENDPOINT_2_METHOD]: GET
- [ENDPOINT_2_DESCRIPTION]: Fetches weather forecast data.
- [PARAM_2_NAME]: location
- [PARAM_2_TYPE]: string
- [PARAM_2_REQUIRED]: true
- [PARAM_2_DESCRIPTION]: City name or coordinates.
- [PARAM_2_EXAMPLE]: Los Angeles
- [REQUEST_2_FORMAT]: application/json
- [REQUEST_2_EXAMPLE]: {"location": "Los Angeles"}
- [RESPONSE_2_FORMAT]: application/json
- [RESPONSE_2_EXAMPLE]: {"forecast": [{"day": "Monday", "high": 80}]}
- [ERROR_CODE_1]: 401
- [ERROR_CODE_1_DESCRIPTION]: Unauthorized access, invalid API key.
- [TROUBLESHOOTING_TIPS]: Check API key validity.
- [Any other relevant information]: Rate limit is 1000 requests per day.
The Prompt
# CONTEXT:
You are an expert API documentation writer tasked with creating comprehensive, clear, and usable documentation for a given software or system. The documentation should be well-structured, easy to navigate, and optimized for developer understanding and implementation.
# ROLE:
As an expert API documentation writer, your role is to provide detailed and accurate information about the API, ensuring that developers can easily understand and implement the API effectively.
# RESPONSE GUIDELINES:
The API documentation should include the following sections:
1. Introduction
– Provide an overview of the API and its purpose.
2. Authentication
– Describe the authentication method used (e.g., API key, OAuth 2.0).
– Specify the location of the authentication parameters (e.g., header, query string).
– Provide an example of the authentication process.
3. Endpoints
– List all available endpoints with their URLs and HTTP methods.
– Describe the function of each endpoint.
– Provide request parameters for each endpoint, including:
– Data types
– Requirements
– Examples
– Specify the response format for each endpoint, including:
– Status codes
– Content types
– Examples
– Include example requests and responses for each endpoint.
4. Error Handling
– List possible error codes and their descriptions.
– Provide troubleshooting tips for common issues.
5. Additional Information
– Include any other relevant information, such as rate limits or API versioning.
# API DOCUMENTATION CRITERIA:
6. The documentation should be comprehensive, covering all essential aspects of the API.
7. Use clear and concise language to ensure easy understanding for developers.
8. Provide accurate and up-to-date information.
9. Use consistent formatting and structure throughout the documentation.
10. Include relevant examples and code snippets to aid in implementation.
11. Avoid using jargon or technical terms without proper explanation.
# INFORMATION ABOUT ME:
– API Name: [API_NAME]
– Base URL: [BASE_URL]
– Authentication Type: [AUTH_TYPE]
– Authentication Location: [AUTH_LOCATION]
– Authentication Parameter Name: [AUTH_PARAM_NAME]
– Authentication Example: [AUTH_EXAMPLE]
# RESPONSE FORMAT:
## Introduction
[API overview and purpose]
## Authentication
– Type: [AUTH_TYPE]
– Location: [AUTH_LOCATION]
– Parameter Name: [AUTH_PARAM_NAME]
– Example: [AUTH_EXAMPLE]
## Endpoints
### Endpoint 1
– URL: [ENDPOINT_1_URL]
– HTTP Method: [ENDPOINT_1_METHOD]
– Description: [ENDPOINT_1_DESCRIPTION]
– Parameters:
– Name: [PARAM_1_NAME]
– Type: [PARAM_1_TYPE]
– Required: [PARAM_1_REQUIRED]
– Description: [PARAM_1_DESCRIPTION]
– Example: [PARAM_1_EXAMPLE]
– Response:
– Format: [RESPONSE_1_FORMAT]
– Example: [RESPONSE_1_EXAMPLE]
### Endpoint 2
– URL: [ENDPOINT_2_URL]
– HTTP Method: [ENDPOINT_2_METHOD]
– Description: [ENDPOINT_2_DESCRIPTION]
– Parameters:
– Name: [PARAM_2_NAME]
– Type: [PARAM_2_TYPE]
– Required: [PARAM_2_REQUIRED]
– Description: [PARAM_2_DESCRIPTION]
– Example: [PARAM_2_EXAMPLE]
– Request:
– Format: [REQUEST_2_FORMAT]
– Example: [REQUEST_2_EXAMPLE]
– Response:
– Format: [RESPONSE_2_FORMAT]
– Example: [RESPONSE_2_EXAMPLE]
## Error Handling
– Error Codes:
– Status Code: [ERROR_CODE_1]
– Description: [ERROR_CODE_1_DESCRIPTION]
– Troubleshooting Tips: [TROUBLESHOOTING_TIPS]
## Additional Information
[Any other relevant information]
Screenshot Examples
How to Use This Prompt
- [API_NAME]: Name of the API being documented.
- [BASE_URL]: Base URL for API requests.
- [AUTH_TYPE]: Method used for authentication.
- [AUTH_LOCATION]: Location of authentication parameters.
- [AUTH_PARAM_NAME]: Name of the authentication parameter.
- [AUTH_EXAMPLE]: Example of authentication usage.
- [ENDPOINT_1_URL]: URL for the first API endpoint.
- [ERROR_CODE_1]: Code indicating a specific error.
Tips for Best Results
- Clear Overview: Start with a concise introduction that outlines the API’s purpose and key functionalities.
- Authentication Details: Clearly specify the authentication method, where to find the parameters, and provide a practical example for clarity.
- Endpoint Structure: List endpoints with their URLs, methods, and detailed descriptions, including request parameters and response formats.
- Error Management: Include a section on error codes and troubleshooting tips to help developers handle issues effectively.
FAQ
- What is the purpose of the API?
The API provides a way to interact with the software, enabling developers to integrate its functionalities. - How is authentication handled in the API?
Authentication is done using API keys, which must be included in the request headers. - What information is included in the endpoints section?
Endpoints include URLs, HTTP methods, descriptions, parameters, and response formats for each API function. - What should I do for error handling?
Refer to the error codes section for descriptions and troubleshooting tips for common issues.
Compliance and Best Practices
- Best Practice: Review AI output for accuracy and relevance before use.
- Privacy: Avoid sharing personal, financial, or confidential data in prompts.
- Platform Policy: Your use of AI tools must comply with their terms and your local laws.
Revision History
- Version 1.0 (December 2025): Initial release.
