GitHub Copilot Coding intermediate

API Documentation Generator from Code

Added Apr 2, 2026

Generate comprehensive API documentation for the following [FRAMEWORK] codebase. The API serves [API_PURPOSE]. Analyze the code and produce documentation in [DOC_FORMAT] format that includes: 1) API Overview section with base URL, authentication method, rate limiting details, and versioning strategy. 2) For each endpoint: HTTP method and path, description of what it does and when to use it, request parameters (path, query, body) with types and required/optional status, request body JSON schema with field descriptions, example request with curl and [LANGUAGE] SDK snippets, success response with status code and full JSON example, error responses for common failure modes (400, 401, 403, 404, 422, 500) with error message formats, and any side effects or webhooks triggered. 3) Data models section documenting shared types and enums. 4) Authentication guide with step-by-step setup. 5) Pagination documentation if applicable. 6) Changelog section template. Use consistent formatting and cross-reference related endpoints. Flag any undocumented behavior, missing error handling, or inconsistencies you find in the code.

Try in GitHub Copilot

About This Prompt

This prompt transforms raw API code into developer-friendly documentation that follows the standards engineers expect from tools like Stripe and Twilio. Instead of manually tracing through route handlers and middleware to document each endpoint, you get complete documentation generated directly from the code with accurate parameter types, response shapes, and error codes. The multi-format code examples (curl plus SDK) reduce friction for developers integrating your API. The prompt also acts as a code review by flagging undocumented behavior and missing error handling, catching issues that would otherwise surface as developer support tickets. Ideal for teams shipping APIs without dedicated technical writers or for generating first-draft documentation that writers can then polish.

Variables to Customize


[FRAMEWORK]

The backend framework used

Example: Express.js with TypeScript


[API_PURPOSE]

What the API does

Example: a task management platform with projects, tasks, comments, and team collaboration


[DOC_FORMAT]

The documentation format to generate

Example: OpenAPI 3.1 YAML with a companion Markdown guide


[LANGUAGE]

The SDK language for code examples

Example: Python

Tips for Best Results

Paste your actual route files rather than describing them for the most accurate documentation
Include your middleware files so Copilot can document authentication and validation behavior
Ask for a Postman collection export alongside the docs for instant API testing

Example Output

```yaml
openapi: 3.1.0
info:
  title: TaskFlow API
  version: 2.1.0
  description: Task management platform API for projects, tasks, and team collaboration.

servers:
  - url: https://api.taskflow.io/v2
    description: Production

paths:
  /projects:
    get:
      summary: List all projects
      description: Returns a paginated list of projects the authenticated user has access to.
      tags: [Projects]
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
        - name: per_page
          in: query
          schema:
            type: integer
            default: 20
            maximum: 100
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectList'
```

api documentation openapi developer-experience rest-api