菜单
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.
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/apify/apify-docs --skill api-doc命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
Review Apify documentation for style guide compliance, quality standards, and best practices. Use when user says "review this doc", "check this page", "audit documentation", "review before PR", "is this ready to publish", or "review-docs". Runs automated checks and manual review against Apify style guide.
Write or edit Apify documentation pages following the style guide. Use when user says "write docs for", "create a new page", "document this feature", "add documentation about", "edit this doc page", or "write a guide for [topic]". Handles platform docs, guides, and reference pages with proper formatting and structure.
Create structured tutorials for Apify Academy or Platform documentation. Use when user says "create a tutorial", "write a tutorial", "build a step-by-step guide", "convert this guide into a tutorial", or "tutorial for [topic]". Handles tutorial structure, learning objectives, prerequisites, step-by-step instructions, code examples, and troubleshooting sections.
基于 SOC 职业分类
正在显示 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 |
apify-api/openapi/paths/apify-api/openapi/components/schemas/apify-api/openapi/code_samples/{javascript,curl}// with @ (e.g., request-queues@{queueId}.yaml){objectName}_{httpMethod} in camelCaseoperationId$ref to apify-api/openapi/openapi.yamlpnpm openapi:lint then pnpm api:rebuildCRITICAL: 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.