openapi
GitHub管理 OpenAPI 规范生成与多语言 SDK/MCP 流水线。涵盖 Swagger 注释处理、文档生成、SDK 构建及自定义代码合并,确保 API 契约一致性与工具链自动化。
Trigger Scenarios
Install
npx skills add flexprice/flexprice --skill openapi -g -y
SKILL.md
Frontmatter
{
"name": "openapi",
"description": "Swagger + Speakeasy SDK\/MCP pipeline (make swagger, sdk-all), api\/custom merge. Trigger: openapi, swagger, sdk-all, MCP."
}
openapi — OpenAPI & SDKs
Source of truth
- Handlers: Swagger comments in
internal/api/**. - Generated specs:
docs/swagger/(run generation — do not hand-edit JSON as primary source).
Standard sequence
After route or Swagger annotation changes:
make swagger
make sdk-all
make sdk-all (per AGENTS.md) validates, generates SDKs/MCP, merges api/custom/**.
OpenAPI-only validation:
make speakeasy-validate
Custom vs generated
- Do not put long-lived custom logic only in generated trees under
api/go,api/typescript,api/python,api/mcp. - Put custom code in
api/custom/<lang>/and rely onmake merge-custom(often part ofsdk-all).
MCP tooling
Filtered spec and allowed tags live under .speakeasy/mcp/ — changing exposed tools requires config update + regenerate flow documented in AGENTS.md.
When to skip full sdk-all
Small internal-only HTTP tweak with no exported contract change: make swagger alone may suffice; coordinate with reviewers if public SDK repos are consumers.
Related
- Tests after API change: expand handler tests or
api/testsif behavior is user-facing SDK contract.
Version History
- 0b58626 Current 2026-08-20 14:48


