灵感菇

AI 技能的自然生态,你的一句话,蔓延出无限连接。

返回搜索

研究学习 / 检索整理

api-documentation

api-documentation

安装量 113GitHub Stars 0更新时间 2026年5月16日

描述

Publish or refresh developer-facing API documentation for REST, GraphQL, webhook, SDK, and developer-portal surfaces: reference docs, quickstarts, task guides, auth/setup notes for API consumers, truthful example requests, error/retry/limit guidance, and migration updates. Use when the contract already exists and the main job is helping integrators succeed with the API, not designing resources or versioning strategy. Triggers on: API docs, developer portal, OpenAPI reference, SDK docs, webhook docs, quickstart, integration guide, endpoint reference, pagination docs, rate-limit docs, migration note, and partner API guide. Route contract design to `api-design`, internal specs/runbooks to `technical-writing`, end-user UI help to `user-guide-writing`, auth implementation to `authentication-setup`, and release-note hygiene to `changelog-maintenance`.

安全审计

使用前的风险提示

未审计

规则审计

未审计
更新 1年1月1日

智能审计

未审计
更新 1年1月1日
designuiauthapidocumentationpublishrefreshdeveloperfacingforrestgraphql