interagent/http-api-design resource

Health v2 · maintenance only

Flags: no_releases no_license

Adoption not part of the score

13684 stars · 1040 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-29, confidence not recorded

A community-maintained HTTP+JSON API design guide extracted from the Heroku Platform API work. It documents consistent conventions for designing REST APIs, covering requests, responses, errors, caching, and resource organization.

Use cases

• design a consistent REST API
• decide on HTTP status codes and error formats
• standardize JSON API conventions across a team
• learn best practices for HTTP+JSON APIs
• avoid bikeshedding when designing API endpoints
• review an existing API against established conventions

When to choose

• you are designing a new HTTP+JSON REST API and want proven conventions
• your team needs a shared API style guide to reduce design debates
• you want guidance grounded in a real production API (Heroku Platform API)

When to avoid

• you need GraphQL, gRPC, or non-REST API design guidance
• you need a tool or library rather than a written guide
• you need exhaustive coverage of HTTP fundamentals for beginners

Facets

learning-resource · maturity maintenance

documentation api-framework apis web-development documentation developer-tools http-api api-design rest style-guide best-practices heroku web-server

Member repositories

For agents

markdown · JSON · MCP: product_card(name="interagent/http-api-design")