About

Imported from ranbot-ai/awesome-skills (skills/api-design-principles/SKILL.md). Install upstream with npx skills add ranbot-ai/awesome-skills --skill api-design-principles. Copyright stays with the author.

API Design Principles

Name: api-design-principles
Author: ranbot-ai

Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.

Use this skill when

Designing new REST or GraphQL APIs
Refactoring existing APIs for better usability
Establishing API design standards for your team
Reviewing API specifications before implementation
Migrating between API paradigms (REST to GraphQL, etc.)
Creating developer-friendly API documentation
Optimizing APIs for specific use cases (mobile, third-party integrations)

Do not use this skill when

You only need implementation guidance for a specific framework
You are doing infrastructure-only work without API contracts
You cannot change or version public interfaces

Instructions

Define consumers, use cases, and constraints.
Choose API style and model resources or types.
Specify errors, versioning, pagination, and auth strategy.
Validate with examples and review for consistency.

Refer to resources/implementation-playbook.md for detailed patterns, checklists, and templates.

Resources

resources/implementation-playbook.md for detailed patterns, checklists, and templates.

Limitations

Use this skill only when the task clearly matches the scope described above.
Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/ranbot-ai-awesome-skills-api-design-principles/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

ranbot-ai-awesome-skills-api-design-principles.ocm.jsonjson

{
  "ocm": "1",
  "id": "ranbot-ai-awesome-skills-api-design-principles",
  "kind": "skill",
  "name": "api-design-principles",
  "description": "Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.",
  "publisher": "ranbot-ai",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "coding"
    ],
    "tags": [
      "skill-md",
      "api",
      "ai",
      "template",
      "design",
      "document",
      "github"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "github",
      "repository": "https://github.com/ranbot-ai/awesome-skills",
      "path": "skills/api-design-principles/SKILL.md",
      "ref": "67901472be1d37b5448718c15647d31fbe34f2c0",
      "url": "https://github.com/ranbot-ai/awesome-skills/blob/67901472be1d37b5448718c15647d31fbe34f2c0/skills/api-design-principles/SKILL.md",
      "key": "ranbot-ai/awesome-skills/skills/api-design-principles/SKILL.md"
    }
  },
  "instructions": "# API Design Principles\n\nMaster REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.\n\n## Use this skill when\n\n- Designing new REST or GraphQL APIs\n- Refactoring existing APIs for better usability\n- Establishing API design standards for your team\n- Reviewing API specifications before implementation\n- Migrating between API paradigms (REST to GraphQL, etc.)\n- Creating developer-friendly API documentation\n- Optimizing APIs for specific use cases (mobile, third-party integrations)\n\n## Do not use this skill whe",
  "cost": {
    "context_tokens": 384
  }
}

Fetch it by URL: GET /api/v1/registry/ranbot-ai-awesome-skills-api-design-principles/manifest?version=1.0.0

Reviews

Star ratings from people who tried it. One review per account; edit yours any time.

No reviews yet. Install it, try it, and be the first to rate it.