Home / wst2002 / claude-code-skills · GitHub

api-design-review SKILL.md skillA

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

Install it, pinned

mdr add wst2002/claude-code-skills/api-design-review@git:20261016.55bd98a

Pins git:20261016.55bd98a in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 17 of 17 checks passed
Kind: SKILL.md skill
Repository: wst2002/claude-code-skills
Path: skills/api-design-review/SKILL.md
Versions recorded: 2
Latest version: git:20261016.55bd98a, committed Oct 16, 2026
First version recorded: Oct 16, 2026
Size: 3,777 bytes
Repository stars: 3
License: MIT

Use when designing a new REST API, reviewing endpoints, routes, controllers or an OpenAPI/Swagger spec, choosing status codes, pagination, versioning or error formats, or checking an API change for breaking changes.

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

# API Design Review

## Overview

Judge an API from the client's side: predictable names, honest status codes, one error shape, safe retries, and no surprise breaking changes. Every finding points at a concrete route and shows the corrected design.

## Method

1. **Inventory.** List every endpoint as `METHOD /path → status codes → request/response shape`. Read routes, controllers, OpenAPI files and DTOs.
2. **Check each endpoint** against the rules below.
3. **Check the API as a whole:** consistency across endpoints matters more than any single choice.
4. **Changes:** if reviewing a diff, compare old and new contracts and flag anything that breaks existing clients.
5. **Report** using the contract below.

## Rules

| Area | Rule |
|---|---|
| Resources | Plural nouns, no verbs: `POST /orders`, not `/createOrder`. Nest only for true ownership: `/users/{id}/orders`. |
| Methods | GET reads and is safe. POST creates. PUT replaces. PATCH partially updates. DELETE removes. Never change state on GET. |
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add wst2002/claude-code-skills/api-design-review@sha256:f8d31e8398e18a19

The line at the top of this page pins the label git:20261016.55bd98a, 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](https://markdownregistry.com/badge/art_ocfes4pagj6zy4fx.svg)](https://markdownregistry.com/a/art_ocfes4pagj6zy4fx)

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

Versions

The registry has recorded 2 versions of this file, all committed on Oct 16, 2026.

version	committed	commit	size	audit
git:20261016.55bd98a latest	2026-10-16	55bd98a	3,777 B	A	view · diff
git:20261016.c3a2cef	2026-10-16	c3a2cef	3,575 B	A	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 (3777 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

wst2002/claude-code-skills · 3 stars · license MIT · pushed 2026-10-19 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_ocfes4pagj6zy4fx
GET https://markdownregistry.com/api/v1/resolve?ref=wst2002/claude-code-skills/api-design-review
GET https://markdownregistry.com/api/v1/blob/f8d31e8398e18a1939e1966818d9a9169aa03f0acaf906df1c6633e7098d0b6a

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 wst2002/claude-code-skills

proof-of-done SKILL.md skill

wst2002/claude-code-skills · plugins/proof-of-done/skills/proof-of-done/SKILL.md · Use before saying work is done, fixed, or complete after changing code. Run the project's checks, show their results…