Muse api-design-principles

Guidelines for designing robust, scalable, and intuitive APIs.

install
source · Clone the upstream repo
git clone https://github.com/myths-labs/muse
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/myths-labs/muse "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/toolkit/api-design-principles" ~/.claude/skills/myths-labs-muse-api-design-principles && rm -rf "$T"
manifest: skills/toolkit/api-design-principles/SKILL.md
source content

API Design Principles

Design APIs that are easy to use and hard to misuse.

RESTful Standards

  • Resources: Nouns, plural (e.g.,
    /users
    ,
    /articles
    ).
  • Methods: GET (read), POST (create), PUT/PATCH (update), DELETE (remove).
  • Status Codes:
    • 200 OK, 201 Created
    • 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found
    • 500 Server Error

Data Format

  • JSON: Standard response format.
  • Snake Case:
    user_id
    ,
    created_at
    (or camelCase if project standard).
  • Pagination:
    page
    ,
    limit
    or cursor-based.
  • Filtering/Sorting: Query parameters.