SuperAPI AI 工具集

api-doc

编程与开发

查看项目

更新于 10-16 05:00

技能介绍

用途:为 Apify 端点创建或更新 OpenAPI 规范与 API 文档,适用于新增 API 端点、更新端点、添加代码示例或新增 schema 等场景。

主要能力与流程:先识别变更类型(新端点、更新端点、添加代码示例、新增 schema),再按 OpenAPI 文件结构组织内容:路径文件放在 apify-api/openapi/paths/,schema 放在 apify-api/openapi/components/schemas/,代码示例放在 apify-api/openapi/code_samples/{javascript,curl}/。

命名约定:路径文件名将 / 替换为 @,例如 request-queues@{queueId}.yaml;operationId 使用 {objectName}_{httpMethod} 的 camelCase 形式;代码示例文件名必须与 operationId 一致。完成后需在主规范 apify-api/openapi/openapi.yaml 中通过 $ref 注册路径,并依次运行 pnpm openapi:lint 与 pnpm api:rebuild 进行校验。

限制:API 文档是生成的,不是手写的,切勿直接编辑 apify-api/docs/ 下的文件。详细模式与示例见 .agents/skills/api-doc/references/openapi-patterns.md,边界情况与流程说明见 .agents/skills/api-doc/references/process.md。