Open Skills Logo
Open Skills

openapi-spec-generation

从代码、设计优先规范及验证模式生成并维护OpenAPI 3.1规范。适用于创建API文档、生成SDK或确保API合约合规性。

查看详情
name:openapi-spec-generationdescription:Generate and maintain OpenAPI 3.1 specifications from code, design-first specs, and validation patterns. Use when creating API documentation, generating SDKs, or ensuring API contract compliance.

OpenAPI Spec Generation

Comprehensive patterns for creating, maintaining, and validating OpenAPI 3.1 specifications for RESTful APIs.

Use this skill when

  • Creating API documentation from scratch

  • Generating OpenAPI specs from existing code

  • Designing API contracts (design-first approach)

  • Validating API implementations against specs

  • Generating client SDKs from specs

  • Setting up API documentation portals

    • Do not use this skill when

  • The task is unrelated to openapi spec generation

  • You need a different domain or tool outside this scope

    • Instructions

  • Clarify goals, constraints, and required inputs.

  • Apply relevant best practices and validate outcomes.

  • Provide actionable steps and verification.

  • If detailed examples are required, open resources/implementation-playbook.md.

    • Resources

  • resources/implementation-playbook.md for detailed patterns and examples.

      • openapi-spec-generation - Agent Skills