All prompts
13 results · tag chatgpt-technical-api-documentation
Multi-language Examples
Provide code examples for these API calls in JavaScript, Python, and Go: 1. Authenticate and get token 2. Make GET request with query parameters 3. Make POST r…
Versioning and Migration
Create a migration guide from API v1 to v2: Breaking changes: - [Change 1] - [Change 2] Timeline: - v1 support until: [date] - Recommended migration start: [da…
Interactive Documentation
Create Swagger/OpenAPI specification format for: - API base URL: [url] - Authentication: [type] - Main endpoints: [list] Include: 1. Complete OpenAPI 3.0 spec…
Prompt Strategy to Avoid Issues
When creating API documentation, avoid: 1. Using placeholder values in examples (use real, working examples) 2. Assuming prior knowledge (explain every concept…
SDK Documentation Prompt Template
Create Python SDK documentation: Installation: pip install api-client Authentication: Bearer token Operations to document: 1. client.users.get(id) - Fetch user…
SDK Documentation Prompt Template
Create SDK documentation for [Language]: SDK features: - Installation via [package manager] - Authentication setup - [Main resource 1] operations - [Main resou…
Error Documentation Framework
Use this prompt for comprehensive error documentation: ```markdown Create error documentation for our REST API: Common errors to cover: - 400 Bad Request (miss…
Error Documentation Framework
** Error Code ** : [CODE] ** HTTP Status ** : [Status] ** Message ** : "User-friendly error message" ** Causes ** : - [Cause 1] - [Cause 2] ** Solutions ** : 1…
Authentication Documentation Template
Document OAuth 2.0 authentication for our API: Supported grant types: 1. Authorization Code (user-facing apps) 2. Client Credentials (server-to-server) Endpoin…
Authentication Documentation Template
** Method ** : [OAuth 2.0 / API Key / JWT / Custom] ** Setup Steps ** : 1. Create [account/app/token] at [where] 2. Retrieve [credential name] 3. Store securel…
Essential Endpoint Details
Document this API endpoint in detail: Endpoint: GET /api/v1/users/{id} Purpose: Retrieve a specific user's profile Path parameters: - id (string, required): Th…
Organization Patterns That Work
Create API documentation structure for [your API name]: Follow this format for each section: - Section title (H2) - Brief description (1 sentence) - Key concep…
Key Information to Gather
I need to document a [REST/GraphQL/gRPC] API with the following details: - Base URL: [your base URL] - Authentication: [Bearer tokens/API keys/OAuth 2.0] - Mai…