AgentSkillsCN

openapi-spec-generation

从代码中生成并维护 OpenAPI 3.1 规范，以设计优先的规范与验证模式为基础。在创建 API 文档、生成 SDK，或确保 API 合同合规时，可优先选用。

SKILL.md
--- frontmatter
name: openapi-spec-generation
description: 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.