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 언어
- 영어
- 스타
- 80
- 포크
- 232
설치 방법
기본적으로 소스를 먼저 확인하는 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에서 보기