Skip to content
MindMapGeneratorOpen editor

Creative & technical

API design template

Resources and endpoints with auth, errors, pagination and versioning decisions in one map before writing a spec.

Best for
Backend engineers
Goal
Design resources, endpoints and conventions
Layout
Mind map (right)
Topics
16
Use this template — freeAll templates

How to use it

  1. One branch per resource.
  2. Record conventions once under Conventions.
  3. Export to Markdown as the start of your spec.
  4. Press Tab to add detail under any topic and Enter for another at the same level.

What’s inside

The full structure as text — the same content you get in the editor.

  • API name
    • Resource: users
      • GET /users
      • POST /users
      • GET /users/{id}
    • Resource: orders
      • GET /orders
      • POST /orders
    • Authentication
    • Conventions
      • Errors
      • Pagination
      • Versioning
      • Rate limits
    • Webhooks
    • Open questions

Last reviewed 2026-10-30. Placeholders are deliberately generic — replace them with your own facts and sources.