Skills
.Work. You
Rest

http-api-design

Official

Design lean, machine-friendly HTTP APIs.

Software Engineering#openapi#rest#json#api-design#http-api#machine-to-machine
Authordeepnoodle-ai
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Design and implement ergonomic JSON HTTP APIs for machine-to-machine communication. This skill helps teams design API endpoints and OpenAPI specs to produce consistent, machine-friendly HTTP JSON APIs, enabling clearer contracts and easier integration.

Core Features & Use Cases

  • OpenAPI-first workflow: Draft an OpenAPI 3.1 spec before implementation to establish a single source of truth for contracts.
  • Resource-oriented design: Model domains as resources with proper HTTP methods, status codes, and clean URL structures.
  • Consistency & error handling: Enforce uniform response envelopes (data), error formats, and predictable behavior across services.
  • Use Case: Designing an offers API with endpoints like /offers and /offers/{offer_id} using snake_case payloads.

Quick Start

Draft a minimal OpenAPI 3.1 specification following these conventions to start implementing a RESTful HTTP API.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: http-api-design
Download link: https://github.com/deepnoodle-ai/creddit/archive/main.zip#http-api-design

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.