openapi-expert
Use when implementing openapi functionality with production-grade patterns and safeguards.
- License 许可
- MIT
- 最近更新
- 2026-04-11
- Stars
- ★ 3
- Forks
- 0
01 前言 Front Matter
- name
- openapi-expert
- metadata
- { "hermes": { "tags": [ "codex-agent", "general" ], "source": "codex-field-kit/general" } }
- description
- Use when implementing openapi functionality with production-grade patterns and safeguards.
03 SKILL.md 正文
Openapi Expert
Focus Areas
- Understanding OpenAPI 3.0 and 3.1 specifications
- Designing clear, concise, and reusable API contracts
- Ensuring proper use of HTTP methods and status codes
- Crafting comprehensive endpoint documentation
- Implementing security schemes and authentication
- Leveraging JSON Schema for request/response validation
- Versioning strategies for API evolution
- Utilizing tools for OpenAPI editing and validation
- Documenting error handling and response formats
- Encouraging RESTful design principles
Approach
- Begin with creating a high-level API design overview
- Break down API into modular components
- Define paths and operations with appropriate parameters
- Use schema definitions to represent complex data models
- Incorporate examples for request and response bodies
- Validate OpenAPI documents with linters and tools
- Iterate based on feedback from stakeholders
- Automatically generate client SDKs from specifications
- Test APIs against OpenAPI contracts automatically
- Update documentation with each API change
Quality Checklist
- All paths and operations are accurately documented
- HTTP methods align with resource actions
- Appropriate status codes for each API response
- Security requirements are clearly defined
- API specifications pass validation without errors
- Examples for all possible responses are provided
- Consistent use of naming conventions and styles
- Deprecation and versioning are managed systematically
- Comprehensive documentation for errors
- Clear instructions for client integration
Output
- OpenAPI specification files in YAML or JSON format
- Detailed API documentation generated from specs
- Visual API diagrams and endpoint summaries
- Client SDKs generated from OpenAPI definitions
- Changelogs for API updates and version changes
- Automated tests for API contract verification
- Security audit reports for API vulnerabilities
- Guides for on-boarding new API users
- Samples for common API use cases
- Issues and recommendations log for continuous improvement
04 同仓库更多 Skills
vercel-react-best-practices
React and Next.js performance optimization guidelines from Vercel Engineering. This skill should be used when writing, reviewing, or refactoring React/Next.js code to ensure optimal performance patterns. Triggers on tasks involving React components, Next.js pages, data fetching, bundle optimization, or performance improvements.
swarm-planner
[EXPLICIT INVOCATION ONLY] Creates dependency-aware implementation plans optimized for parallel multi-agent execution.
super-swarm-spark
Only to be triggered by explicit super-swarm-spark commands.
role-creator
Create and install Codex custom agent roles in ~/.codex/config.toml, generate role config files, enforce supported keys, and guide users through required role inputs (model, reasoning effort, developer_instructions).
read-github
Read and search GitHub repository documentation via gitmcp.io MCP service. **WHEN TO USE:** - User provides a GitHub URL - User mentions a specific repo in owner/repo format - User asks "what does this repo do?", "read the docs for X repo", or similar - User wants to search code or docs within a repo
planner
Create comprehensive, phased implementation plans with sprints and atomic tasks. Use when user says: "make a plan", "create a plan", "plan this out", "plan the implementation", "help me plan", "design a plan", "draft a plan", "write a plan", "outline the steps", "break this down into tasks", "what's the plan for", or any similar planning request. Also triggers on explicit "/planner" or "/plan" commands.