Nota:
* Copilot los archivos prompt están en versión preliminar pública y están sujetos a cambios. Los archivos de comandos solo están disponibles en VS Code, Visual Studio y en IDEs de JetBrains. Consulte Acerca de la personalización de las respuestas de GitHub Copilot.
- Para obtener ejemplos aportados por la comunidad de archivos de entrada para idiomas específicos y escenarios concretos, consulte el sitio Personalizaciones IncreíblesGitHub Copilot.
Este archivo de mensaje genera especificaciones de OpenAPI 3.0 para puntos de conexión de API REST mediante el análisis del código de la API y la creación de documentación estandarizada y legible por máquina.
Mensaje de especificación de OpenAPI
---
agent: 'agent'
description: 'Generate OpenAPI 3.0 specification for API endpoints'
---
## Task
Analyze the API endpoint code and generate a valid OpenAPI 3.0 specification in YAML format.
## OpenAPI Structure
Generate a complete OpenAPI spec including:
1. **OpenAPI Header**
- OpenAPI version (3.0.3)
- API info (title, description, version)
- Server configuration
2. **Path Definitions**
- HTTP method and path
- Operation summary and description
- Tags for organization
3. **Parameters Schema**
- Path parameters with type validation
- Query parameters with constraints and defaults
- Request body schema using proper JSON Schema
- Required vs optional parameters
4. **Response Schemas**
- Success responses (200, 201, etc.) with schema definitions
- Error responses (400, 401, 404, 500) with error schema
- Content-Type specifications
- Realistic example values
5. **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 applicable
Focus 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.
---
agent: 'agent'
description: 'Generate OpenAPI 3.0 specification for API endpoints'
---
## Task
Analyze the API endpoint code and generate a valid OpenAPI 3.0 specification in YAML format.
## OpenAPI Structure
Generate a complete OpenAPI spec including:
1. **OpenAPI Header**
- OpenAPI version (3.0.3)
- API info (title, description, version)
- Server configuration
2. **Path Definitions**
- HTTP method and path
- Operation summary and description
- Tags for organization
3. **Parameters Schema**
- Path parameters with type validation
- Query parameters with constraints and defaults
- Request body schema using proper JSON Schema
- Required vs optional parameters
4. **Response Schemas**
- Success responses (200, 201, etc.) with schema definitions
- Error responses (400, 401, 404, 500) with error schema
- Content-Type specifications
- Realistic example values
5. **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 applicable
Focus 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.
Procedimiento para usar este archivo de mensaje
- Guarde el contenido anterior como
document-api.prompt.mden la carpeta.github/prompts. - En Visual Studio Code, muestra la vista Chat de Copiloto y escribe
/document-api. Opcionalmente, también puedes especificar el punto de conexión concreto para el que quieres obtener documentación si escribesendpoint_focus=GET /activities, por ejemplo.
Información adicional
- Uso de archivos de mensaje en Visual Studio Code en la documentación de Visual Studio Code: información sobre cómo crear y usar archivos de mensaje
- Acerca de la personalización de las respuestas de GitHub Copilot: Introducción a la personalización de respuestas en GitHub Copilot
- Awesome GitHub Copilot Customizations: repositorio de archivos de mensaje personalizados aportados por la comunidad y otras personalizaciones para lenguajes y escenarios específicos