rc-openapi

Solid

Creates or updates an OpenAPI specification by discovering the project's HTTP endpoints, request schemas, and response models from source. Use to keep an openapi.yaml in sync after API changes, or to generate a spec for an existing service. Do not use for Postman collections (use rc-postman), README docs (use rc-readme), or editing source code.

API & Backend 19 stars 1 forks Updated 2 weeks ago MIT

Install

View on GitHub

Quality Score: 79/100

Stars 20%
43
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# OpenAPI Specification Generate or maintain an OpenAPI document that mirrors the API's real routes, request contracts, and response models. Document only what exists in source. This skill is standalone and stack-agnostic; it detects how the project defines HTTP endpoints. It only writes the spec file — it never modifies source code. ## Required Inputs - None. Operates on the current repository. - Optional: the spec output path (default `.techdocs/docs/openapi.yaml`, or the existing location if one is found) and the target OpenAPI version. ## Workflow 1. Locate the spec and pick the version. - Search for an existing `openapi.yaml`/`openapi.json` (`.techdocs/docs/`, `docs/`, repo root). If found, read it for comparison and reuse its output path and version. Otherwise default the output to `.techdocs/docs/openapi.yaml`, creating the directory if needed. - For a new spec, default to **OpenAPI 3.1.0**. Use 3.0.3 only if the project's tooling (gateway, codegen, docs renderer) pins it — note the choice in the report. 2. Discover HTTP endpoints from source. Detect the routing mechanism and enumerate every endpoint with method, full path, handler reference, and any summary/description from doc comments or manifest annotations. Routing may live in framework routers (Express, Gin, Spring, FastAPI, etc.) or infrastructure manifests (`serverless.yml` `http` events, API Gateway). Ignore non-HTTP triggers. 3. Extract request contracts from each handler's validation layer: path...

Details

Author
rodolfochicone
Repository
rodolfochicone/rc-project
Created
1 months ago
Last Updated
2 weeks ago
Language
JavaScript
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category