Home / jeffallan / claude-skills · GitHub

api-designer SKILL.md skillA

api-designer from jeffallan/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 jeffallan/claude-skills/api-designer@v1.1.0

Pins v1.1.0 in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 17 of 17 checks passed
Kind: SKILL.md skill
Repository: jeffallan/claude-skills
Path: skills/api-designer/SKILL.md
Versions recorded: 5
Latest version: v1.1.0, committed Oct 3, 2026
First version recorded: Mar 6, 2026
Size: 8,008 bytes
Repository stars: 12,006
License: MIT

Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture. Invoke for resource modeling, versioning strategies, pagination patterns, error handling standards.

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 Designer

Senior API architect specializing in REST and GraphQL APIs with comprehensive OpenAPI 3.1 specifications.

## Core Workflow

1. **Analyze domain** — Understand business requirements, data models, and client needs
2. **Model resources** — Identify resources, relationships, and operations; sketch entity diagram before writing any spec
3. **Design endpoints** — Define URI patterns, HTTP methods, request/response schemas
4. **Specify contract** — Create OpenAPI 3.1 spec; validate before proceeding: `npx @redocly/cli lint openapi.yaml`
5. **Mock and verify** — Spin up a mock server to test contracts: `npx @stoplight/prism-cli mock openapi.yaml`
6. **Plan evolution** — Design versioning, deprecation, and backward-compatibility strategy

## Reference Guide

Load detailed guidance based on context:

| Topic | Reference | Load When |
|-------|-----------|-----------|
| REST Patterns | `references/rest-patterns.md` | Resource design, HTTP methods, HATEOAS |
| Versioning | `references/versioning.md` | API versions, deprecation, breaking changes |
| Pagination | `references/pagination.md` | Cursor, offset, keyset pagination |
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add jeffallan/claude-skills/api-designer@sha256:02f7480c64238595

The line at the top of this page pins the label v1.1.0, 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_rhgy5ishhffefmjt.svg)](https://markdownregistry.com/a/art_rhgy5ishhffefmjt)

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

Versions

The registry has recorded 5 versions of this file, between Mar 6, 2026 and Oct 3, 2026, about one every 53 days.

version	committed	commit	size	audit
v1.1.0 latest	2026-10-03	958e60f	8,008 B	A	view · diff
v1.1.0	2026-10-03	ec755b7	7,926 B	A	view · diff
v1.1.0	2026-04-29	efebc44	7,832 B	A	view · diff
v1.1.0	2026-03-06	c7afefb	7,734 B	A	view · diff
v1.0.0	2026-03-06	cba3273	7,734 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 (8008 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

jeffallan/claude-skills · 12,006 stars · license MIT · pushed 2026-10-21 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_rhgy5ishhffefmjt
GET https://markdownregistry.com/api/v1/resolve?ref=jeffallan/claude-skills/api-designer
GET https://markdownregistry.com/api/v1/blob/02f7480c64238595ad94b340c6fcefa1d4050dc3c562ea96de3a7be29a7b0f7a

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 jeffallan/claude-skills

CLAUDE.md CLAUDE.md file

jeffallan/claude-skills · CLAUDE.md

git:20261003.eae31de · audit A · 12,006 stars

angular-architect SKILL.md skill

jeffallan/claude-skills · skills/angular-architect/SKILL.md · Generates Angular 17+ standalone components, configures advanced routing with lazy loading and guards, implements NgRx…