agentleFS
Sign inStart free
vivek-viswanatvivek-viswanat/dev-arsenal/skills/rest-api-architect/SKILL.md

rest-api-architect

Skill4 starsChanged 8 months agoMITView on GitHub

Expert in designing resource-oriented REST APIs using OpenAPI 3.1 specifications.

4 other projects use a version of this.

Adopted by

Most recently taken up by

  • Other versions4 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 4

    1. ice-lfernandes/claude-spring-architect★ 11same name
    2. nerviz-ai/nerviz★ 11same name
    3. ralvarez-ai/ralvaskills★ 4same name
    4. ralvarezdev/ralvaskills★ 4same name

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository2 other files it gives its agents.

The file

Show its rules and text

We split this skill into the rules it gives an agent

13 rules. 0 are common, 4 are distinctive, and 9 are very specific to this project.

  • 0

    Common

    Most of the 4 edited versions we read keep these.

  • 4

    Distinctive

    This author's own choices. Worth a look.

  • 9

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this skill when:

    line 7
  2. Very specific:

    Nouns Only: Use /users, not /getUsers.

    line 15
  3. Very specific:

    Plurality: Use plural nouns for collections (/orders) and IDs for instances (/orders/{id}).

    line 16
  4. Very specific:

    Case: All paths MUST be kebab-case and lowercase.

    line 17
  5. Very specific:

    OperationId: Every operation must have a unique, camelCase operationId (e.g., listUsers).

    line 27
  6. Very specific:

    Descriptions: Every parameter, property, and response must have a description field for AI discoverability.

    line 28
  7. Distinctive:

    Error Format: Follow RFC 9457 (Problem Details for HTTP APIs).

    line 32
  8. Distinctive:

    Pagination: Use cursor-based pagination for large datasets.

    line 35
  9. Very specific:

    Filtering: Use query parameters (e.g., /products?category=tech).

    line 36
  10. Very specific:

    Sorting: Use a standardized sort parameter (e.g., ?sort=-created_at).

    line 37
  11. Distinctive:

    When asked to "create an endpoint," first define the Path, then the Request Schema, then the Success/Error Responses.

    line 40
  12. Very specific:

    Always use $ref to keep schemas modular and reusable in components/schemas.

    line 41
  13. Very specific:

    Ensure all Date/Time fields use format: date-time (ISO 8601).

    line 42

“Common” is measured: kept by at least 6 in 10 of the 4 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Context

Use this skill when:

  1. Designing new API endpoints or resources.
  2. Reviewing existing OpenAPI (swagger.yaml/json) files.
  3. Generating boilerplate code from an API contract.

Design Principles

1. Resource-First Naming

  • Nouns Only: Use /users, not /getUsers. Actions are defined by HTTP methods.
  • Plurality: Use plural nouns for collections (/orders) and IDs for instances (/orders/{id}).
  • Case: All paths MUST be kebab-case and lowercase.

2. Semantic HTTP Methods

  • GET: Idempotent retrieval. No side effects.
  • POST: Create a new resource or trigger a non-idempotent action.
  • PUT: Full replacement of a resource (Idempotent).
  • PATCH: Partial update (Preferred over PUT for performance).
  • DELETE: Remove a resource.

3. Standardization (OpenAPI 3.1)

  • OperationId: Every operation must have a unique, camelCase operationId (e.g., listUsers).
  • Descriptions: Every parameter, property, and response must have a description field for AI discoverability.
  • Status Codes: - 201 Created for successful POSTs.
    • 422 Unprocessable Entity for validation errors (Standard in 2026).
    • 429 Too Many Requests for rate-limiting.
  • Error Format: Follow RFC 9457 (Problem Details for HTTP APIs).

4. Collection Handling

  • Pagination: Use cursor-based pagination for large datasets.
  • Filtering: Use query parameters (e.g., /products?category=tech).
  • Sorting: Use a standardized sort parameter (e.g., ?sort=-created_at).

Instructions for the Agent

  • When asked to "create an endpoint," first define the Path, then the Request Schema, then the Success/Error Responses.
  • Always use $ref to keep schemas modular and reusable in components/schemas.
  • Ensure all Date/Time fields use format: date-time (ISO 8601).

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free