artwo.xyz / ArPiStar-Methods
AI‑agnostic methods for development and documentation, with traceable artifacts and step‑by‑step collaboration.
Star
Fork 0
Watch
ArPiStar-Methods ArPiDoc definitions models api-reference.md
654 B
Markdown
at main

Doc Model — API Reference #

Purpose #

  • Provide precise, authoritative reference for API consumers.

Best for #

  • Public or internal APIs
  • SDKs / services

Audience #

  • Developers integrating the API

Tone #

  • Precise, terse, consistent

Required sections #

  • Overview
  • Authentication
  • Base URL / environment
  • Endpoints (grouped by resource)
  • Request/response examples
  • Error codes
  • Rate limits

Optional sections #

  • Pagination
  • Webhooks
  • Changelog

Inputs needed #

  • API schema
  • Example requests/responses

Output suggestions #

  • docs/api-reference.md
  • docs/api/ per resource

Notes #

  • Use tables and consistent formatting.