ChatGPTΒ Prompt to
Create API Documentation Guide
π‘
Create comprehensive, clear, and structured API documentation with the mega-prompt for ChatGPT. Ensure developers can easily understand and implement APIs effectively, covering all essential aspects from authentication to error handling with relevant examples.
What This Prompt Does:
β Converts user input into a structured API documentation outline.
β Ensures the documentation includes essential sections like Introduction, Authentication, Endpoints, Error Handling, and Additional Information.
β Focuses on clarity, accuracy, and usability for developers implementing the API.
Tips:
β Utilize Visual Aids: Incorporate diagrams or flowcharts to visually represent the authentication process and data flow between endpoints, enhancing comprehension for visual learners.
β Interactive Examples: Implement tools like Swagger UI or Postman within the documentation to allow developers to test API calls directly from the documentation, ensuring they understand the practical application.
β Version Control: Maintain a changelog section to document updates and changes to the API, helping developers track modifications and adapt their implementations accordingly.
π API Documentation Guide
ChatGPTΒ 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, and examples
- Specify the response format for each endpoint, including status codes, content types, and 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:
1. The documentation should be comprehensive, covering all essential aspects of the API
2. Use clear and concise language to ensure easy understanding for developers
3. Provide accurate and up-to-date information
4. Use consistent formatting and structure throughout the documentation
5. Include relevant examples and code snippets to aid in implementation
6. 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]
GET FULL ACCESS
#CONTEXT:
You are SEO Checker AI, an SEO professional who helps Entrepreneurs make their blog
articles more SEO-friendly. You are a world-class expert in finding SEO issues and
giving recommendationson how to fix them.
#GOAL:
I want you to analyze my blog article and give me recommendations on improving its SEO.
I need this information to rank better at Google.
#FORMAT OF OUR INTERACTION
1. I will provide you with the source code of my blog article
2. You will analyze the page source code
3. You will give me a holistic analysis of its SEO in the checklist format:
- SEO score from 1 to 10
- What is done right
- What is done wrong
#SEO CHECKLIST CRITERIA:
- Your checklist should have 20-30 criteria
- Be specific and concise. Your criteria should be self-explanatory
- Include numbers in the criteria if it's applicable
- Focus on SEO practices that have the biggest impact on ranking
- Prioritize SEO practices that are widely recognizable by the SEO community
- Don't include irrelevant SEO practices with zero to no impact on this article
#RESPONSE STRUCTURE:
## SEO Score
## What's done right
β
Criteria
β
Criteria
β
Criteria
## What's done wrong
β Criteria
β Criteria
β Criteria
#RESPONSE FORMATTING:
Use Markdown. Follow the response structure.
How To Use The Prompt:
β Fill in the [API_NAME], [BASE_URL], [AUTH_TYPE], [AUTH_LOCATION], [AUTH_PARAM_NAME], and [AUTH_EXAMPLE] placeholders with specific details about your API. For example, if your API is for a weather service, you might fill them in as follows:
- [API_NAME]: "WeatherAPI"
- [BASE_URL]: "https://api.weatherapi.com"
- [AUTH_TYPE]: "API key"
- [AUTH_LOCATION]: "header"
- [AUTH_PARAM_NAME]: "apiKey"
- [AUTH_EXAMPLE]: "curl -H 'apiKey: your_api_key' https://api.weatherapi.com/v1/current.json"
β Example: To effectively use this prompt, ensure that you replace the placeholders with accurate and specific information about your API. For instance, if your API requires OAuth 2.0 authentication, specify this under [AUTH_TYPE], and provide a detailed authentication example under [AUTH_EXAMPLE] to guide users on how to authenticate requests properly.
Example Input:
#INFORMATION ABOUT ME:
β API Name: PromptAPI
β Base URL: https://api.promptapi.com
β Authentication Type: API key
β Authentication Location: Header
β Authentication Parameter Name: X-API-Key
β Authentication Example: curl -H "X-API-Key: your_api_key_here" https://api.promptapi.com/data
Additional Tips:
β Use Consistent Naming Conventions: Ensure that the names of endpoints, parameters, and response fields are consistent throughout the documentation, making it easier for developers to understand and implement the API.
β Include Rate Limit Information: Provide details about rate limits, such as the maximum number of requests allowed per minute or hour, to help developers manage their API usage effectively.
β Provide Code Samples in Multiple Programming Languages: Include code samples in popular programming languages, such as Python, JavaScript, and Java, to cater to developers with different language preferences and backgrounds.
β Offer SDKs and Libraries: Provide links to software development kits (SDKs) or libraries that developers can use to integrate the API into their applications, saving them time and effort in implementing the API from scratch.
β Offer Support Channels: Clearly state the available support channels, such as email, forums, or a dedicated support portal, where developers can seek assistance or report issues related to the API documentation.
Additional Information:
Create comprehensive API documentation with the mega-prompt for ChatGPT, designed to guide expert API documentation writers in structuring clear, detailed, and user-friendly documentation. This tool ensures all critical aspects of API functionality are covered, from authentication methods to endpoint details.
β Ensure thorough coverage of all API functionalities, enhancing developer comprehension and ease of use.
β Provide structured and clear guidelines for documenting API endpoints, authentication processes, and error handling.
β Include essential examples and code snippets, making the API more accessible for implementation.
This mega-prompt serves as an essential resource for producing high-quality API documentation that meets professional standards. It supports consistency in documentation structure and clarity, which are crucial for developers to effectively integrate and utilize APIs in their projects.
In conclusion, streamline your API documentation process with the mega-prompt for ChatGPT, ensuring accuracy, clarity, and usability in your technical writing endeavors.
π Related Prompts:
Create Research Paper Outline
Enhance your writing with this ChatGPT mega-prompt, meticulously correcting grammar, punctuation, and syntax for clarity and conciseness.
This is some text inside of a div block.
Recommend Low-Calorie Meals
Create delicious low-calorie recipes effortlessly with this ChatGPT mega-prompt, featuring easy instructions, nutritional breakdowns, and ingredient customization.
This is some text inside of a div block.
Enhance Document Layout
Enhance your text's readability with this ChatGPT mega-prompt, refining structure, formatting, and flow for a professional presentation.
This is some text inside of a div block.
Improve Document Quality
Enhance your writing with this ChatGPT mega-prompt, refining clarity, coherence, and quality while correcting errors and improving flow.
This is some text inside of a div block.
Edit Line Content
Enhance text clarity effortlessly with this ChatGPT mega-prompt, simplifying complex sentences while preserving original meaning and intent.
This is some text inside of a div block.
Improve Writing Accuracy
Elevate your writing with this ChatGPT mega-prompt, ensuring error-free content through meticulous grammar correction and stylistic enhancement.
This is some text inside of a div block.
Optimize Website Content
Enhance your technical writing with this ChatGPT mega-prompt, simplifying complex ideas for clarity and ensuring accessibility for all readers.
This is some text inside of a div block.
Collect User Feedback
Enhance your technical documents with this ChatGPT mega-prompt, ensuring clarity, coherence, and accessibility for a general audience.
This is some text inside of a div block.
Create FAQ Content
Create an informative FAQ section with this ChatGPT mega-prompt, addressing common user questions clearly and concisely while enhancing understanding of the topic.
This is some text inside of a div block.
Conduct Research & Fact-Checking
Create comprehensive technical documentation with this ChatGPT mega-prompt, ensuring accuracy, clarity, and accessibility for diverse audiences.
This is some text inside of a div block.
Create Key Points
Create a comprehensive list of key points with this ChatGPT mega-prompt, ensuring clarity, accuracy, and relevance for all readers.
This is some text inside of a div block.
Create Paper Introduction
Create an effective FAQ section with this ChatGPT mega-prompt, addressing common questions clearly and categorizing answers for easy navigation.
This is some text inside of a div block.