# WhiteHouse/api-standards

Repository: https://github.com/WhiteHouse/api-standards
Canonical: https://ross.abutalabs.com/products/api-standards
License Family: other
Archived: true
Last push: 2019-06-08T17:00:51+00:00

## Health v2 (maintenance only)
Score: 10/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 0, release rhythm 35, longevity 100
- inputs: {"age_days": 5005, "days_push": 2643, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases, archived, no_license
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 3087, forks 880 (observed 2026-08-28T04:07:42.167454+00:00)

## What it is
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
- artifact type: learning-resource
- maturity: maintenance
- function: documentation, api-framework
- domain: apis, web-development, documentation, developer-tools
- platform: -
- tags: api-standards, rest, api-design, guidelines, http, best-practices, web-server

## Member repositories
- WhiteHouse/api-standards (main) score 10

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:07:42.167454+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T07:27:31.157145+00:00, confidence not recorded.
  - readme: https://github.com/WhiteHouse/api-standards (fetched 2026-08-28T04:07:42.167454+00:00, sha 7d5dad8a7d7f)
- Data as of 2026-08-30T08:39:29.467469+00:00.