agentleFS
Sign inStart free
DongDuong2001DongDuong2001/pudo-code-system/skills/plan/api-design/SKILL.md

api-design-plan

Skill5 starsChanged 5 months agoMITView on GitHub

Planning and designing scalable, secure, and intuitive APIs

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    When defining RESTful endpoints, GraphQL schemas, or gRPC definitions.

    line 11
  2. Distinctive:

    When creating API documentation (OpenAPI/Swagger).

    line 12
  3. Distinctive:

    When planning API versioning and deprecation strategies.

    line 13
  4. Distinctive:

    Security: Ensure authentication (OAuth2, JWT) and authorization (RBAC/ABAC) are built into the design.

    line 19

≈ “Common” is an estimate: at least 1 in 5 of the 308,232 skill files we read have a rule of the same kind, not the same words. “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

API Design Skill

This skill is utilized during the PLAN phase when defining the contract between different services or between a client and a backend.

When to use this skill

  • When defining RESTful endpoints, GraphQL schemas, or gRPC definitions.
  • When creating API documentation (OpenAPI/Swagger).
  • When planning API versioning and deprecation strategies.

Guidelines

  • Consistency: Maintain consistent naming conventions (e.g., standardizing on plural nouns for REST collections).
  • Versioning: Plan for API versioning from Day 1 (e.g., /v1/users).
  • Pagination & Filtering: Design endpoints to handle large datasets natively.
  • Security: Ensure authentication (OAuth2, JWT) and authorization (RBAC/ABAC) are built into the design.

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.

Reviews can't be read right now.

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