Point it at any repository and GitHub Copilot reads the code to document the HTTP API: endpoints, parameters, request and response shapes, and authentication. It works with any language or framework.
Features
Endpoint browser: every endpoint grouped and searchable, with an explanation of what it does.
API tester: send requests from the panel. Credentials come from VS Code Secret Storage or from your Bruno, Postman and .env files, and are never sent to the AI.
Proxy endpoints: wildcard paths such as /studio/beta/* have an editable path.
OpenAPI export: view and download the spec per endpoint as YAML or JSON.
README export: a shareable onboarding document with overview, authentication and per-endpoint reference.
Model choice: pick the Copilot model before each generation, or let the extension choose the cheapest suitable one.
Per-repo context: detected auth and routes are stored in .apidocs/context.json, which you can edit to correct the AI.
Requirements
GitHub Copilot with an active sign-in.
Usage
Open a repository and click the API Docs icon in the Activity Bar (Cmd+Alt+A).
Choose Scan this workspace and pick a model.
Browse endpoints, try requests, and export from the OpenAPI and README tabs.
Settings
Setting
Description
apidocs.baseUrl
Base URL used by the tester.
apidocs.modelFamily
Preferred model when "Automatic" is chosen.
apidocs.maxCharsPerFile
Maximum characters of one source file sent to the model.
Privacy
Source files are sent to GitHub Copilot to generate the documentation. Credentials are never included in prompts.
