Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.apivalk.com/llms.txt

Use this file to discover all available pages before exploring further.

Versioning and resource structure

API versioning strategy

Use URL-based versioning. Examples: Why:
  • Explicit versioning in every request
  • Easier debugging, monitoring, and routing
  • Cleaner folder structure
  • Old versions can coexist safely

Resource structure and folder organization

Use RESTful, hierarchical naming to reflect relationships. Example:
GET /users/{user_uuid}/addresses
Guidelines:
  • Plural nouns only (/users, /addresses)
  • Keep nesting shallow (2 levels max)
  • Actions are defined by HTTP verbs, not URLs