Pular para o conteúdo
Kitbay
Skill

api-documentation

MITAtualizado em 10 de nov. de 202649.466Estrelas no GitHub

A workflow skill in the agentic-awesome-skills collection that organises API documentation work into seven phases, each pointing to other skills in the collection that the agent reads before use.

O que a skill ensina

A workflow skill in the agentic-awesome-skills collection that organises API documentation work into seven phases, each pointing to other skills in the collection that the agent reads before use. The phases are: taking stock of endpoints, requests, responses, authentication, errors and rate limits; writing an OpenAPI specification; a developer guide with onboarding, common patterns and troubleshooting; tested code samples and tutorials; interactive documentation with a try-it feature; a documentation site with navigation and search; and upkeep through automated generation, checks and feedback. Only the relevant phases are used. Cloud calls, publishing and spending need explicit permission, and try-it features should use sandbox endpoints and test credentials.

O que faz

  • Inventory an API's endpoints and behaviour
  • Write an OpenAPI specification
  • Draft a developer guide and code samples
  • Plan an interactive documentation site