rest-api-design SKILL.md skillA

rest-api-design from secondsky/claude-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add secondsky/claude-skills/rest-api-design@git:20260402.75421fa

Pins git:20260402.75421fa in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
secondsky/claude-skills
Path
plugins/rest-api-design/skills/rest-api-design/SKILL.md
Versions recorded
2
Latest version
git:20260402.75421fa, committed Apr 2, 2026
First version recorded
Dec 24, 2025
Size
2,206 bytes
Repository stars
243
License
MIT

Designs RESTful APIs with proper resource naming, HTTP methods, status codes, and response formats. Use when building new APIs, establishing API conventions, or designing developer-friendly interfaces.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# REST API Design

Design RESTful APIs with proper conventions and developer experience.

## Resource Naming

```
# Good - nouns, plural, hierarchical
GET    /api/users
GET    /api/users/123
GET    /api/users/123/orders
POST   /api/users
PATCH  /api/users/123
DELETE /api/users/123

# Bad - verbs, actions in URL
GET    /api/getUsers
POST   /api/createUser
POST   /api/users/123/delete
```

## HTTP Methods

| Method | Purpose | Idempotent |
|--------|---------|------------|
| GET | Read resource | Yes |
| POST | Create resource | No |
| PUT | Replace resource | Yes |
| PATCH | Partial update | Yes |
| DELETE | Remove resource | Yes |

## Status Codes

| Code | Meaning | Use For |
|------|---------|---------|
| 200 | OK | Successful GET, PATCH |
| 201 | Created | Successful POST |
| 204 | No Content | Successful DELETE |
| 400 | Bad Request | Validation errors |
| 401 | Unauthorized | Missing auth |
| 403 | Forbidden | Insufficient permissions |
| 404 | Not Found | Resource doesn't exist |
| 429 | Too Many Requests | Rate limited |

## Response Format

```json
{
  "data": {
    "id": "123",
    "type": "user",
    "attributes": {
      "name": "John",
      "email": "john@example.com"
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add secondsky/claude-skills/rest-api-design@sha256:d516e1c8d3fb4580

The line at the top of this page pins the label git:20260402.75421fa, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_rl6bbb25qhw7n7f4.svg)](https://markdownregistry.com/a/art_rl6bbb25qhw7n7f4)

4 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 2 versions of this file, between Dec 24, 2025 and Apr 2, 2026, about one every 100 days.

versioncommittedcommitsizeaudit
git:20260402.75421fa latest2026-04-02 75421fa 2,206 BA view · diff
git:20251224.ba827ce2025-12-24 ba827ce 2,193 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (2206 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

secondsky/claude-skills · 243 stars · license MIT · pushed 2026-10-31 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_rl6bbb25qhw7n7f4
GET https://markdownregistry.com/api/v1/resolve?ref=secondsky/claude-skills/rest-api-design
GET https://markdownregistry.com/api/v1/blob/d516e1c8d3fb4580b070c3d6b8360f7dfcb79ea0c47d7849f3e9ed07d38c7da1

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from secondsky/claude-skills

AGENTS.md AGENTS.md file
secondsky/claude-skills · AGENTS.md
git:20260829.7ecf025 · audit A · 243 stars
CLAUDE.md CLAUDE.md file
secondsky/claude-skills · CLAUDE.md
git:20260917.a0994f7 · audit A · 243 stars
aceternity-ui SKILL.md skill
secondsky/claude-skills · plugins/aceternity-ui/skills/aceternity-ui/SKILL.md · 100+ animated React components (Aceternity UI) for Next.js with Tailwind. Use for hero sections, parallax, 3D effects…
v1.1.0 · audit A · 243 stars
api-authentication SKILL.md skill
secondsky/claude-skills · plugins/api-authentication/skills/api-authentication/SKILL.md · Secure API authentication with JWT, OAuth 2.0, API keys. Use for authentication systems, third-party integrations…
git:20260402.75421fa · audit A · 243 stars
api-changelog-versioning SKILL.md skill
secondsky/claude-skills · plugins/api-changelog-versioning/skills/api-changelog-versioning/SKILL.md · Creates comprehensive API changelogs documenting breaking changes, deprecations, and migration strategies for API…
git:20260402.75421fa · audit A · 243 stars
api-contract-testing SKILL.md skill
secondsky/claude-skills · plugins/api-contract-testing/skills/api-contract-testing/SKILL.md · Verifies API contracts between services using consumer-driven contracts, schema validation, and tools like Pact. Use…
git:20260402.75421fa · audit A · 243 stars
api-design-principles SKILL.md skill
secondsky/claude-skills · plugins/api-design-principles/skills/api-design-principles/SKILL.md · Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight…
git:20260402.75421fa · audit A · 243 stars
api-error-handling SKILL.md skill
secondsky/claude-skills · plugins/api-error-handling/skills/api-error-handling/SKILL.md · Implements standardized API error responses with proper status codes, logging, and user-friendly messages. Use when…
git:20260402.75421fa · audit A · 243 stars
api-filtering-sorting SKILL.md skill
secondsky/claude-skills · plugins/api-filtering-sorting/skills/api-filtering-sorting/SKILL.md · Builds flexible API filtering and sorting systems with query parameter parsing, validation, and security. Use when…
git:20260402.75421fa · audit A · 243 stars
api-gateway-configuration SKILL.md skill
secondsky/claude-skills · plugins/api-gateway-configuration/skills/api-gateway-configuration/SKILL.md · Configures API gateways for routing, authentication, rate limiting, and request transformation in microservice…
git:20260402.75421fa · audit A · 243 stars
api-pagination SKILL.md skill
secondsky/claude-skills · plugins/api-pagination/skills/api-pagination/SKILL.md · Implements efficient API pagination using offset, cursor, and keyset strategies for large datasets. Use when building…
git:20260402.75421fa · audit A · 243 stars
api-rate-limiting SKILL.md skill
secondsky/claude-skills · plugins/api-rate-limiting/skills/api-rate-limiting/SKILL.md · Implements API rate limiting using token bucket, sliding window, and Redis-based algorithms to protect against abuse…
git:20260402.75421fa · audit A · 243 stars

Every file in secondsky/claude-skills

Other files named rest-api-design

rest-api-design SKILL.md skill
eagerworks/skills · skills/rest-api-design/SKILL.md · Designs and reviews REST APIs: resource naming, HTTP methods and status codes, payload and error formats, pagination…
v1.0.0 · audit A · 15 stars

Browse by kind, by grade A, or by owner.