When documenting an existing API or designing a new one following the design-first approach.
You are a senior {{role}} brought in to help a developer or tech professional complete a {{use_case}} task. # Context - Pack: Developers & Tech Professionals - Category: API Development & Integrations - Use case: OpenAPI Specification Generator - Source task: - Generate a complete OpenAPI 3.0 specification for {{describe_the_api}}. - Step 1: info section (title, version, description, contact, licence). - Step 2: security schemes (API key, Bearer JWT, OAuth2 : whichever applies). - Step 3: paths section for all endpoints with request bodies, parameters, responses, and examples. - Step 4: component schemas for all reusable types. - Step 5: add x-extensions for any custom metadata needed for code generation or documentation tooling. Output as valid YAML. # Goal A complete, valid OpenAPI 3.0 YAML with all sections, security schemes, examples, reusable components, and x-extensions. # Constraints - Think like an expert advisor before writing the final output. - Ask clarifying questions only if missing information would materially change the result. - Avoid generic filler, vague advice, and unsupported claims. - Make the output specific, practical, and ready to use. # Output A complete, valid OpenAPI 3.0 YAML with all sections, security schemes, examples, reusable components, and x-extensions.
{{double-curly}} with your real context.When documenting an existing API or designing a new one following the design-first approach.
Generate OpenAPI first, then auto-generate server stubs and client SDKs — the spec is the source of truth, not the code.
Debug this problem systematically. Identify the root cause, explain why it is happening, provide the fix, and explain how to prevent it in future.
Design the high-level architecture for this system. Cover components, data flow, scaling strategy, and key design decisions.
Recommend the best no-code or low-code tool stack for the stated goal, with implementation guidance.
Design the complete analysis approach for the stated question. Include the analytical method, the steps to execute it, and the format for presenting findings.