openapi✓ تایید شده

محتوای SKILL.md

---
name: openapi
description: OpenAPI/Swagger specification, code generation, documentation, and validation.
allowed-tools: Read, Write, Edit, Bash, Glob, Grep
---

# OpenAPI Skill

Expert assistance for creating OpenAPI specifications and API documentation.

## Capabilities

- Write OpenAPI 3.x specifications
- Generate client/server code
- Create interactive documentation
- Validate API contracts
- Design request/response schemas

## Usage

Invoke this skill when you need to:
- Document REST APIs
- Generate API clients
- Validate API contracts
- Create interactive docs

## Specification Pattern

```yaml
openapi: 3.0.3
info:
  title: Users API
  version: 1.0.0

paths:
  /users:
    get:
      summary: List users
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserList'

components:
  schemas:
    User:
      type: object
      required: [id, name, email]
      properties:
        id:
          type: string
        name:
          type: string
        email:
          type: string
          format: email
```

## Best Practices

- Use $ref for reusable schemas
- Document all responses
- Include examples
- Version your specs

## Target Processes

- api-documentation
- api-design
- client-generation

مجوز

مجوز اعلام‌شده: MIT

MIT License

Copyright (c) 2026 a5c-ai

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

مشاهدهٔ مجوز در مخزن منبع — نسخهٔ منتشرشده در آن‌جا مرجع است.