api-doc
Create or update OpenAPI specifications and API documentation for Apify endpoints. Use when user says "add API endpoint", "create OpenAPI spec", "document this endpoint", "add code samples for API", "update API docs", or "api-doc". Handles OpenAPI YAML, schemas, code samples, and operation IDs.
来源信息
- 仓库
- apify/apify-docs
- 最近来源活动
- 2026年8月4日 10:07
- 检测到的 SKILL.md 语言
- 英语
- 星标
- 81
- 分支
- 239
安装方式
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
检查来源文件
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
文件资源管理器
3 个文件正在显示 SKILL.md
SKILL.md
来源说明 · 只读预览- name
- api-doc
- description
- Create or update OpenAPI specifications and API documentation for Apify endpoints. Use when user says "add API endpoint", "create OpenAPI spec", "document this endpoint", "add code samples for API", "update API docs", or "api-doc". Handles OpenAPI YAML, schemas, code samples, and operation IDs.
- allowed-tools
- Read Write Edit Bash Glob Grep
- argument-hint
- endpoint-name
# API documentation
## Process
1. **Identify change type** - new endpoint, update endpoint, add code samples, or new schema
2. **Follow OpenAPI file structure**:
- Paths in `apify-api/openapi/paths/`
- Schemas in `apify-api/openapi/components/schemas/`
- Code samples in `apify-api/openapi/code_samples/{javascript,curl}/`
3. **Create or update files** using naming conventions:
- Path files: replace `/` with `@` (e.g., `request-queues@{queueId}.yaml`)
- Operation IDs: `{objectName}_{httpMethod}` in camelCase
- Code sample filenames must match `operationId`
4. **Register in main spec** - add path `$ref` to `apify-api/openapi/openapi.yaml`
5. **Validate** - `pnpm openapi:lint` then `pnpm api:rebuild`
**CRITICAL**: API docs are generated, not hand-written. Never edit files in `apify-api/docs/` directly.
For detailed patterns and examples, see `.agents/skills/api-doc/references/openapi-patterns.md`.
For edge cases and process notes, see `.agents/skills/api-doc/references/process.md`.
在 GitHub 查看