Skip to content
TrustedSkillsbeta
Back to all skills

Api Design Patterns

Checked
asyrafhussin·vlatest·backend·MIT

Helps with API, design, patterns 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 asyrafhussin/agent-skills --skill api-design-patterns -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

asyrafhussin

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

    Only contacts known or declared hosts: github.com.

    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.

    Hosts contacted

    github.comsource host

  • 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 asyrafhussin/agent-skills at 1aa0ff717c.

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

Commit
1aa0ff717c
Manifest
skills/api-design-patterns/SKILL.md
Scanned
44 files, 14,052 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 provides a comprehensive guide to RESTful API design principles, offering 38 rules across 7 categories. It helps AI agents ensure APIs are consistent, developer-friendly, and adhere to best practices for resource design, error handling, security, pagination, versioning, response format, and documentation. The tool aims to improve the quality and maintainability of backend services and API workflows.

When to use it

This skill is useful in the following scenarios:

  • Designing new API endpoints.
  • Reviewing existing API structures for improvement.
  • Implementing robust error handling and validation processes.
  • Setting up pagination, filtering, and sorting functionality.
  • Planning a clear API versioning strategy.
  • Configuring appropriate API security measures (authentication, authorization, rate limiting).
  • Creating comprehensive API documentation (OpenAPI/Swagger).

Key capabilities

  • Provides 38 rules across 7 categories of RESTful API design.
  • Covers critical areas like resource design, error handling, and security.
  • Offers guidance on pagination & filtering techniques.
  • Includes recommendations for API versioning strategies.
  • Suggests best practices for response formatting and documentation.
  • Categorizes rules by priority (Critical, High, Medium).

Example prompts

  • "What are the key considerations for resource design in a RESTful API?"
  • "How should I handle errors consistently in my API responses?"
  • "Give me some best practices for implementing API security."
  • "What is cursor-based pagination and when should I use it?"

Tips & gotchas

  • The skill prioritizes rules, with "Critical" categories (Resource Design, Error Handling, Security) being the most important to follow.
  • Refer to the rule prefixes (e.g., rest-, error-, sec-) for quick identification of specific guidelines within each category.
  • This skill focuses specifically on RESTful API design patterns and does not cover broader backend development topics.