WhiteHouse/api-standards resource

Health v2 · maintenance only

Flags: no_releases archived no_license

Adoption not part of the score

3087 stars · 880 forks observed · 2026-08-28

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

A set of White House Web API design standards documenting pragmatic REST guidelines, RESTful URL conventions, HTTP verb usage, response formats, error handling, and versioning. It is a reference document rather than executable software, intended to encourage consistency and best practices across API development.

Use cases

• design a restful api with consistent url conventions
• learn best practices for rest api versioning
• standardize http verb usage across team apis
• define error handling and response formats for web apis
• create api style guidelines for an organization
• decide between url-based and header-based api metadata

When to choose

• you are drafting internal API design guidelines and want a proven reference
• you need pragmatic REST conventions for URL structure, filtering, and versioning
• you want a concise, readable standards document to align a team

When to avoid

• you need executable tooling, libraries, or linting for API design
• you require GraphQL, gRPC, or non-REST API standards
• you need actively updated standards covering modern practices like OpenAPI or JSON:API

Facets

learning-resource · maturity maintenance

documentation api-framework apis web-development documentation developer-tools api-standards rest api-design guidelines http best-practices web-server

Member repositories

For agents

markdown · JSON · MCP: product_card(name="WhiteHouse/api-standards")