Skip to main content
Glama
scanady
by scanady
nexus-document-api.prompt.md1.54 kB
--- 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 Generate production-ready OpenAPI specification that can be used with Swagger UI, Postman, and code generators.

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/scanady/engineering-standards-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server