Skip to content
TrustedSkillsbeta
Back to all skills

Rest Api Best Practices

Checked
imsurajj·vlatest·backend

Helps with REST APIs, API, best practices 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 imsurajj/yc-skills --skill rest-api-best-practices -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

imsurajj

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 imsurajj/yc-skills at 1cab71cb13.

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

Commit
1cab71cb13
Manifest
skills/rest-api-best-practices/SKILL.md
Scanned
1 file, 423 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 guidance and recommendations for designing and implementing REST APIs following industry best practices. It helps ensure your APIs are well-structured, secure, performant, and maintainable. The skill focuses on aspects like resource naming conventions, HTTP method usage, error handling, and API versioning.

When to use it

  • Designing a new API: Get feedback on the proposed design before implementation.
  • Refactoring an existing API: Identify areas for improvement in an older API's structure and functionality.
  • Troubleshooting API issues: Understand common pitfalls and potential solutions when encountering problems with an API.
  • Ensuring API consistency: Maintain a consistent approach across multiple APIs within a project or organization.

Key capabilities

  • Resource naming conventions
  • HTTP method usage guidelines
  • Error handling best practices
  • API versioning strategies

Example prompts

  • "Suggest resource names for an API endpoint that manages customer orders."
  • "What's the recommended HTTP method to use for deleting a resource?"
  • "How should I handle errors in my REST API and return appropriate status codes?"
  • “Give me some strategies for versioning my REST API.”

Tips & gotchas

This skill assumes basic familiarity with RESTful principles. While it provides guidance, it's not a substitute for understanding the underlying concepts of HTTP and API design.