api-design SKILL.md skillA

api-design from martinolivero/saas-builder is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add martinolivero/saas-builder/api-design@git:20261007.f2beefe

Pins git:20261007.f2beefe in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
martinolivero/saas-builder
Path
skills/api-design/SKILL.md
Versions recorded
2
Latest version
git:20261007.f2beefe, committed Oct 7, 2026
First version recorded
Jun 6, 2026
Size
5,372 bytes
Repository stars
4
License
MIT

This skill should be used when designing or building an API — endpoints, routes, request/response shapes, error formats, pagination, versioning, or deciding REST vs GraphQL. Trigger phrases include "design the API", "build an endpoint", "REST or GraphQL", "how should I structure my routes", "API error format", "paginate results", "version my API", "validate env vars", "idempotency", "what should this endpoint return". It applies proven REST conventions and a clear REST-vs-GraphQL decision…

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

This skill turns "I need an endpoint" into an API that is consistent, predictable, and safe to evolve. It encodes the conventions that the best public APIs (Stripe, Microsoft, GitHub) share.

Analogy: an API is the menu of a restaurant. A good menu is consistent — every dish described the same way, prices where you expect, no surprises. A messy menu makes every order a negotiation.

## Discovery (max 3 questions, only if unknown)

1. Who consumes this — your own React SPA only, or also mobile / partners / the public?
2. Is it mostly simple CRUD, or deeply nested reads across many relations?
3. Is it public-facing (needs versioning + stability) or internal?

## Step 1 — REST vs GraphQL (decide first)

**Default to REST.** Reach for **GraphQL only when**: clients need flexible, deeply nested reads across many relations; you have multiple divergent clients (web + mobile + partners); or you're composing several backend services. For a single React SPA on one Postgres DB, REST (or tRPC for end-to-end TS types) is simpler and cacheable.

If you do choose GraphQL:
- **Solve N+1 from day one with DataLoader** (batch + cache per request).
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add martinolivero/saas-builder/api-design@sha256:5231457a449f76d7

The line at the top of this page pins the label git:20261007.f2beefe, 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_ypp25kumwfj7tpkg.svg)](https://markdownregistry.com/a/art_ypp25kumwfj7tpkg)

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

Versions

The registry has recorded 2 versions of this file, between Jun 6, 2026 and Oct 7, 2026, about one every 123 days.

versioncommittedcommitsizeaudit
git:20261007.f2beefe latest2026-10-07 f2beefe 5,372 BA view · diff
git:20260606.1d02dd62026-06-06 1d02dd6 4,346 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 (5372 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

martinolivero/saas-builder · 4 stars · license MIT · pushed 2026-10-11 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_ypp25kumwfj7tpkg
GET https://markdownregistry.com/api/v1/resolve?ref=martinolivero/saas-builder/api-design
GET https://markdownregistry.com/api/v1/blob/5231457a449f76d7151ba62a67f9c62163e6a3b7513f526a5d397e50af1b789a

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 martinolivero/saas-builder

accessibility SKILL.md skill
martinolivero/saas-builder · skills/accessibility/SKILL.md · This skill should be used when building or reviewing UI for accessibility — keyboard navigation, screen readers, ARIA…
git:20260606.1d02dd6 · audit A · 4 stars
ai-features SKILL.md skill
martinolivero/saas-builder · skills/ai-features/SKILL.md · This skill should be used when putting an LLM inside the product itself — a chatbot or support agent, AI-generated…
git:20261007.f2beefe · audit A · 4 stars
architecture-primer SKILL.md skill
martinolivero/saas-builder · skills/architecture-primer/SKILL.md · This skill should be used when the user wants to design, plan, or decide the architecture of a system, app, or platform…
git:20260605.5e4d680 · audit A · 4 stars
auth SKILL.md skill
martinolivero/saas-builder · skills/auth/SKILL.md · This skill should be used when adding authentication or authorization to an app or SaaS — login, signup, sessions…
git:20261007.f2beefe · audit A · 4 stars
data-modeling SKILL.md skill
martinolivero/saas-builder · skills/data-modeling/SKILL.md · This skill should be used when designing a database schema, modeling data, choosing a database, planning migrations, or…
git:20261007.f2beefe · audit A · 4 stars
deployment SKILL.md skill
martinolivero/saas-builder · skills/deployment/SKILL.md · This skill should be used when shipping an app to production — setting up CI/CD, deploys, preview environments, error…
git:20261007.f2beefe · audit A · 4 stars
design-taste-frontend SKILL.md skill
martinolivero/saas-builder · skills/design-taste-frontend/SKILL.md · Anti-slop frontend skill for landing pages, portfolios, and redesigns. The agent reads the brief, infers the right…
git:20260618.989db49 · audit B · 4 stars
frontend-performance SKILL.md skill
martinolivero/saas-builder · skills/frontend-performance/SKILL.md · This skill should be used when a frontend feels slow, fails Core Web Vitals, has a large bundle, or needs performance…
git:20260606.1d02dd6 · audit A · 4 stars
image-to-code SKILL.md skill
martinolivero/saas-builder · skills/image-to-code/SKILL.md · Elite website image-to-code skill for Codex. For visually important web tasks, it must first generate the design…
git:20260618.989db49 · audit A · 4 stars
integrations SKILL.md skill
martinolivero/saas-builder · skills/integrations/SKILL.md · This skill should be used when the product talks to a platform you do not control — receiving webhooks, syncing with a…
git:20261007.f2beefe · audit A · 4 stars
landing-page SKILL.md skill
martinolivero/saas-builder · skills/landing-page/SKILL.md · This skill should be used when the user wants to create a landing page, sales page, home page, lead-capture page, or…
git:20261007.f2beefe · audit A · 4 stars
multi-tenancy SKILL.md skill
martinolivero/saas-builder · skills/multi-tenancy/SKILL.md · This skill should be used when several customers, organizations, teams or workspaces share one application and their…
git:20261007.f2beefe · audit A · 4 stars

Every file in martinolivero/saas-builder

Other files named api-design

api-design SKILL.md skill
affaan-m/ecc · docs/es/skills/api-design/SKILL.md · Patrones de diseño REST API incluyendo nomenclatura de recursos, códigos de estado, paginación, filtrado, respuestas de…
git:20260607.ac0f11c · audit A · 284,510 stars
api-design SKILL.md skill
affaan-m/ecc · .agents/skills/api-design/SKILL.md · REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning…
git:20260918.c752aac · audit A · 284,510 stars
api-design SKILL.md skill
affaan-m/ecc · .kiro/skills/api-design/SKILL.md · REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning…
git:20260323.535120d · audit A · 284,510 stars
api-design SKILL.md skill
affaan-m/ecc · docs/ja-JP/skills/api-design/SKILL.md · リソース命名、ステータス コード、ページネーション、フィルタリング、エラー応答、バージョン管理、およびレート制限を含む REST API デザイン パターン。
git:20260517.ec9ace9 · audit A · 284,510 stars
api-design SKILL.md skill
cbrock84/headcount · plugins/technology/skills/api-design/SKILL.md · Designs interfaces that survive their consumers — resource modeling, errors, versioning, pagination, and compatibility…
git:20260916.e72e404 · audit A · 2,076 stars
api-design SKILL.md skill
hashgraph-online/awesome-codex-plugins · plugins/Colin4k1024/tsp/skills/api-design/SKILL.md · REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning…
git:20260512.6523792 · audit A · 1,352 stars
api-design SKILL.md skill
yonatangross/orchestkit · plugins/ork/skills/api-design/SKILL.md · API contract design for REST and GraphQL, covering resource shape, URL and header versioning with deprecation windows…
v2.0.0 · audit A · 296 stars
api-design SKILL.md skill
yonatangross/orchestkit · src/skills/api-design/SKILL.md · API contract design for REST and GraphQL, covering resource shape, URL and header versioning with deprecation windows…
v2.0.0 · audit A · 296 stars

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