Skip to content
TrustedSkillsbeta
Back to all skills

Api Design Principles

Checked
ovachiever·vlatest·backend

Helps with API, design, principles as part of developing backend services and APIs workflows.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add ovachiever/droid-tings --skill api-design-principles -a claude-code

  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

ovachiever

Taken from the source listing. We haven't verified who controls this account.

Install target

Live repository

Not pinned. Installing fetches whatever the repository holds at the time you run the command.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.

  • Declares what it does: passed

    SKILL.md parses and declares a name and a description.

    SKILL.md exists, its frontmatter parses, and it declares a name and a description.

  • No undeclared network calls: passed

    Makes no network calls.

    Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.

  • No obfuscated payloads: passed

    No encoded or obfuscated payloads.

    No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.

  • No credential access: passed

    Reads no keys, tokens, keychains or credential files.

    Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.

  • No pipe-to-shell installers: passed

    No pipe-to-shell or download-and-run installers.

    No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.

  • Pinned to a commit: passed

    Scanned ovachiever/droid-tings at 7acd12a754.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit
7acd12a754
Manifest
skills/api-design-principles/SKILL.md
Scanned
5 files, 1,668 lines
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

About this skill

What it does

This skill helps you master REST and GraphQL API design principles, enabling you to build intuitive, scalable, and maintainable APIs. It provides guidance on resource-oriented architecture for REST APIs, schema-first development for GraphQL APIs, and various versioning strategies. Ultimately, this skill assists in creating developer-friendly APIs that are robust and long-lasting.

When to use it

  • Designing new REST or GraphQL APIs.
  • Refactoring existing APIs for improved usability.
  • Establishing API design standards within a team.
  • Reviewing API specifications before implementation.
  • Migrating between different API paradigms (e.g., from REST to GraphQL).

Key capabilities

  • RESTful Design Principles: Guidance on resource-oriented architecture, HTTP method semantics (GET, POST, PUT, PATCH, DELETE), and URL structure.
  • GraphQL Design Principles: Focuses on schema-first development, query structures, mutations, and subscriptions.
  • API Versioning Strategies: Explores options like URL versioning, header versioning, and query parameter versioning.
  • REST API Design Patterns: Includes examples of resource collection design patterns.

Example prompts

  • "Explain the principles of a RESTful API."
  • "What are the key differences between REST and GraphQL?"
  • "How should I handle API versioning in my backend service?"
  • "Give me an example of a good resource-oriented endpoint for managing users."

Tips & gotchas

  • This skill focuses on design principles; it doesn't provide code implementation.
  • Familiarity with basic API concepts (HTTP methods, resources) is helpful to get the most out of this skill.