skills.rest
gridi-ai
gridi-aiOFFICIAL
Explore all skills by this author →
WebsiteGitHub

be-spec

Generate OpenAPI 3.0 specifications from tech specs for REST APIs.

1|Updated Mar 24, 2026
Search Tags:#documentation#openapi#backend#swagger#code-generation#api-spec#contract-driven-development
One-click install
npx skills add https://github.com/gridi-ai/gridi-skills --skill be-spec
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: be-spec
Source: https://github.com/gridi-ai/gridi-skills/tree/main/skills/be-spec
Command: npx skills add https://github.com/gridi-ai/gridi-skills --skill be-spec

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing precise OpenAPI 3.0 specifications from raw tech specs to drive backend and frontend contracts, eliminating ambiguity and drift.

Core Features & Use Cases

  • Generates OpenAPI 3.0 specs from tech specs, including endpoints, request/response schemas, and authentication details.
  • Produces Swagger/OpenAPI documentation ready for codegen and client generation.
  • Use Case: Convert a tech-spec document into a full API contract that developers can implement against.

Quick Start

Provide the tech spec document and have the skill generate a complete OpenAPI specification.

Frequently Asked Questions about be-spec

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate OpenAPI 3.0 specifications from a technical spec document?▼

You generate OpenAPI 3.0 specifications by providing a raw tech spec document to define endpoints, request/response schemas, and authentication details for your REST API projects.

What is the best way to create Swagger documentation for backend microservices?▼

Creating Swagger documentation is best achieved by converting tech specs into machine-parseable OpenAPI 3.0 outputs, ensuring backend service contracts are ready for codegen and client generation.

Can I use a tech spec to define API contracts for contract-driven development?▼

Yes, you can use a tech spec to establish API contracts for contract-driven development by generating complete OpenAPI specifications that developers can implement against without ambiguity.

How does generating OpenAPI specs handle error formatting and ID strategies?▼

Generating OpenAPI specs applies crew-config.json settings such as idStrategy and error formatting to ensure the resulting API documentation remains consistent and machine-parseable.

Does the generated OpenAPI specification include authentication details?▼

Yes, the generated OpenAPI specification includes authentication details alongside endpoints and request/response schemas to provide a full API contract for backend services.

Related Skills

Explore More Software Engineering Skills→
ehtbantonehtbanton

openapi-spec-builder

Generate OpenAPI 3.x specification files in YAML or JSON format.

Community
Intermediate
Dokkabei97Dokkabei97
2

api-first-design

Design API contracts with OpenAPI and GraphQL schemas.

Community
Intermediate
eleva-labseleva-labs

api-validate

Validate API implementations against OpenAPI specifications and contracts.

Official
Intermediate
ArabelaTsoArabelaTso
142

interface-specification-generator

Generate and validate OpenAPI 3.0 YAML/JSON interface specifications.

Community
Intermediate