API Documentation

Generate OpenAPI specs and comprehensive API documentation.

ChatGPTClaude

Documentationdocumentationapiopenapi

by API Team

Feb 20, 2024

0upvotes

Variables

Prompt Template

Generate comprehensive API documentation for: API Endpoint: {{endpoint}} Method: {{method}} Purpose: {{purpose}} Request body/params:

json

{{requestSchema}}

Create: 1. OpenAPI/Swagger specification 2. Endpoint description 3. Request/Response examples 4. Error codes and handling 5. Authentication requirements 6. Rate limiting details 7. Code samples in {{languages}}

Other Useful Prompts

Debug Code Issues

Analyze code for bugs and provide detailed debugging steps with explanations.

ChatGPTClaudeCopilotCodex

Debuggingdebuggingbug-fixcode-analysis

System Architecture Design

Design scalable system architecture with detailed component diagrams.

ChatGPTClaude

Architecturearchitecturesystem-designscalability

Refactor Legacy Code

Transform legacy code into modern, maintainable patterns.

ChatGPTClaudeCopilot

Refactoringrefactoringmodernizationclean-code

Build AI Agent

Create an AI agent with specific capabilities and behavior patterns.

ChatGPTClaude

AI Agentsai-agentsautomationtool-use