Index of every page on this site: llms.txt
All skills
jeremylongshore avatar

/generating-rest-apis

@820dfc8
Run it yourself

Generate complete REST API implementations from OpenAPI specifications or database schemas. Use when generating RESTful API implementations. Trigger with phrases like "generate REST API", "create RESTful API", or "build REST endpoints".

Use this Skill: https://skilld.dev/gh/jeremylongshore/tons-of-skills-marketplace/generating-rest-apis

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈65 tokens for metadata: the name and description. ≈1.1k when used: this file. ≈2.4k more on demand in 3 files.

Description uses 3.2% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈259 characters, or 3.2%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Generating REST APIs

Overview

Generate complete, production-ready REST API implementations from OpenAPI specifications, database schemas, or resource definitions. Scaffold CRUD endpoints with proper HTTP method semantics, content negotiation, pagination, filtering, and HATEOAS link generation across Express, FastAPI, Spring Boot, and Gin frameworks.

Prerequisites

  • Node.js 18+ with Express/Fastify, or Python 3.10+ with FastAPI/Flask, or Java 17+ with Spring Boot, or Go 1.21+ with Gin/Echo
  • OpenAPI 3.0+ specification or database schema (SQL DDL, Prisma, Sequelize models)
  • HTTP testing tool: curl, httpie, or Postman
  • Database server (PostgreSQL, MySQL, MongoDB) accessible for ORM integration
  • Package manager configured (npm, pip, Maven, or go modules)

Instructions

  1. Scan the project for existing OpenAPI specs, database models, or route definitions using Glob and Read to establish current API surface area.
  2. Parse resource entities from the specification and generate model definitions with field types, validation constraints, and relationship mappings.
  3. Create route files implementing all five standard REST operations per resource: GET /resources (list with pagination), GET /resources/:id, POST /resources, PUT /resources/:id, and DELETE /resources/:id.
  4. Implement controller logic with input validation using JSON Schema or framework-native validators (Zod, Pydantic, Bean Validation).
  5. Add query parameter support for filtering (?status=active), sorting (?sort=-created_at), field selection (?fields=id,name), and cursor-based or offset pagination.
  6. Wire authentication middleware to protect mutation endpoints (POST, PUT, DELETE) while allowing read access per configuration.
  7. Generate standardized error response envelopes with RFC 7807 Problem Details format for all 4xx/5xx responses.
  8. Create integration tests covering happy paths, validation failures, 404s, and auth rejection for every endpoint.
  9. Produce or update the OpenAPI 3.0 specification to match the generated implementation.

See references/implementation.md for the full step-by-step implementation guide.

Output

  • ${CLAUDE_SKILL_DIR}/src/routes/ - Express/Fastify route definitions with HTTP method handlers
  • ${CLAUDE_SKILL_DIR}/src/controllers/ - Business logic separated from routing
  • ${CLAUDE_SKILL_DIR}/src/models/ - ORM models with validation rules and relationships
  • ${CLAUDE_SKILL_DIR}/src/middleware/auth.js - JWT/API key authentication middleware
  • ${CLAUDE_SKILL_DIR}/src/middleware/validate.js - Request schema validation middleware
  • ${CLAUDE_SKILL_DIR}/openapi.yaml - Generated OpenAPI 3.0 specification
  • ${CLAUDE_SKILL_DIR}/tests/ - Integration test suite per resource endpoint

Error Handling

Error Cause Solution
400 Bad Request Request body fails schema validation Return field-level validation errors with JSON pointer paths to invalid fields
401 Unauthorized Missing or malformed Authorization header Respond with WWW-Authenticate header indicating expected auth scheme
404 Not Found Resource ID does not exist in data store Return RFC 7807 body with resource type and requested ID for debugging
409 Conflict Unique constraint violation on create/update Include conflicting field name and existing value hint in error response
429 Too Many Requests Client exceeds rate limit Return Retry-After header with seconds until next allowed request window

Refer to references/errors.md for comprehensive error patterns.

Examples

E-commerce product API: Generate CRUD endpoints for a Product resource with nested Category relationships, image upload handling, and inventory tracking fields with optimistic concurrency via ETags.

Multi-tenant SaaS API: Scaffold tenant-scoped endpoints where all queries automatically filter by tenant_id extracted from JWT claims, with tenant isolation enforced at the middleware layer.

Public read API with admin writes: Create a dual-access API where GET endpoints are publicly cacheable (Cache-Control headers) while POST/PUT/DELETE require admin-role JWT tokens.

See references/examples.md for additional examples.

Resources

  • OpenAPI Specification 3.1: https://spec.openapis.org/oas/v3.1.0
  • RFC 7807 Problem Details for HTTP APIs
  • JSON:API Specification for standardized response formatting
  • Express.js, FastAPI, Spring Boot, and Gin framework documentation

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts2mo3 checks · Risk SAFE
  • Gen Agent Trust Hub2mo

    This skill provides a comprehensive framework for generating REST API implementations using various languages and frameworks. It utilizes standard development tools and retrieves configuration data from the author's verified domain.

  • Socket2mo

    No alerts

  • Snyk2mo

    Risk: LOW · No issues

Signed by skilld at 820dfc8. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 20 hours ago.

Activeupdated last month
What it can do
Reads files Edits files Runs commands
version
1.24.0
author
Jeremy Longshore <jeremy@intentsolutions.io>
tags
[
  "api",
  "database",
  "rest-apis"
]
All 6 allowed tools
ReadWriteEditGrepGlobBash(api:rest-*)
Other metadata
compatibility
Designed for Claude Code

README badge

README badge for jeremylongshore/tons-of-skills-marketplace/generating-rest-apis