Mern api docs

Skill edfenton/claude-skills/mern/mern-api-docs

A collection of Claude Code skills for iOS, MERN, NEAN, and shared development workflows

Install

npx -y skills add edfenton/claude-skills --skill mern-api-docs

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

2 stars2 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

Generate OpenAPI documentation from Zod schemas and API routes.

SKILL.md

2.2 KB, as published. Nobody here has run it

Purpose

Generate and serve OpenAPI (Swagger) documentation derived from Zod schemas and Next.js API routes.

Arguments

--serve — Start Swagger UI at /api/docs
--export <path> — Export OpenAPI spec to file (default: openapi.json)
(no args) — Generate spec and report endpoints documented

What gets created

apps/web/
├── app/api/docs/route.ts           # Swagger UI endpoint
├── src/lib/openapi.ts              # OpenAPI spec generator
└── openapi.json                    # Generated spec (if --export)

How it works

Scans packages/shared/schemas/ for Zod schemas
Scans apps/web/src/app/api/ for route handlers
Extracts request/response types from Zod schemas
Generates OpenAPI 3.0 spec with:
- Endpoints from file structure
- Request bodies from Create*Schema
- Response schemas from *ResponseSchema
- Query params from *QuerySchema
- Path params from [id] segments

Schema conventions for docs

// packages/shared/schemas/todo-item.ts

/** @description Create a new todo item */
export const CreateTodoItemSchema = z.object({
  /** @description Item title (required) */
  title: z.string().min(1).max(200),
  /** @description Optional description */
  description: z.string().optional(),
});

/** @description Todo item response */
export const TodoItemSchema = z.object({
  id: z.string(),
  title: z.string(),
  // ...
});

JSDoc comments become OpenAPI descriptions.

Swagger UI

When --serve is used, Swagger UI is available at /api/docs:

Interactive API explorer
Try-it-out functionality (with auth)
Schema visualization

Workflow

Ensure schemas follow naming conventions
Run skill to generate/update spec
Review generated documentation
Optionally serve Swagger UI

Output

Endpoints documented count
Schemas extracted count
Missing documentation warnings
Spec file location (if exported)

Reference

For setup and customization, see reference/mern-api-docs-reference.md