BLOCKWERK
◢ CATALOG / integration

OpenAPI Spec Author

PRO

Design a clean, valid OpenAPI 3.1 contract for your REST API.

Author an OpenAPI 3.1 specification for a REST API — paths, operations, parameters, request/response schemas, reusable components, security schemes, and examples — as valid YAML that tools can consume. Use when asked to write an OpenAPI/Swagger spec, define an API contract, or design REST endpoints as a spec.

Ask for it in plain English, e.g.

“write an OpenAPI spec”“Swagger spec”“define the API contract”“design these endpoints as a spec”

Works in

AGENTS.mdClaudeGitHub CopilotCursorOllamaOpenAI GPTs
◢◢ EXAMPLE OUTPUT

You ask: Write an OpenAPI 3.1 spec for Northwind's Products API. Base URL https://api.northwind.example/v1, bearer auth. Endpoints: GET /products (list, with a ?category filter) and GET /products/{id} (one product). A product has id, name, category, and price. Include a standard error schema.

Example output from the OpenAPI Spec Author skill

Example output shown for illustration. Your assistant produces this live from your own request once the skill is installed.