Movatterモバイル変換


[0]ホーム

URL:


Skip to main content
GitHub Docs

Document API

Generate comprehensive API documentation from your code.

Note

This prompt file generates OpenAPI 3.0 specifications for REST API endpoints by analyzing your API code and creating standardized, machine-readable documentation.

OpenAPI specification prompt

Text
---mode: 'agent'description: 'Generate OpenAPI 3.0 specification for API endpoints'---## TaskAnalyze the API endpoint code and generate a valid OpenAPI 3.0 specification in YAML format.## OpenAPI StructureGenerate a complete OpenAPI spec including:1. **OpenAPI Header**   - OpenAPI version (3.0.3)   - API info (title, description, version)   - Server configuration2. **Path Definitions**   - HTTP method and path   - Operation summary and description   - Tags for organization3. **Parameters Schema**   - Path parameters with type validation   - Query parameters with constraints and defaults   - Request body schema using proper JSON Schema   - Required vs optional parameters4. **Response Schemas**   - Success responses (200, 201, etc.) with schema definitions   - Error responses (400, 401, 404, 500) with error schema   - Content-Type specifications   - Realistic example values5. **Components Section**   - Reusable schemas for request/response models   - Security schemes (Bearer token, API key, etc.)   - Common parameter definitions## Requirements- Generate valid OpenAPI 3.0.3 YAML that passes validation- Use proper JSON Schema for all data models- Include realistic example values, not placeholders- Define reusable components to avoid duplication- Add appropriate data validation (required fields, formats, constraints)- Include security requirements where applicableFocus on: ${input:endpoint_focus:Which specific endpoint or endpoints should be documented?}Generate production-ready OpenAPI specification that can be used with Swagger UI, Postman, and code generators.

How to use this prompt file

  1. Save the above content asdocument-api.prompt.md in your.github/prompts folder.
  2. In Visual Studio Code, display the Copilot Chat view and enter/document-api. Optionally, you can also specify what specific endpoint you want documentation for by typingendpoint_focus=GET /activities, for example.

Further reading


[8]ページ先頭

©2009-2025 Movatter.jp