{"adoption": {"forks": 1040, "observed_at": "2026-08-28T04:11:04.531327+00:00", "stars": 13684}, "canonical_url": "https://ross.abutalabs.com/products/http-api-design", "card": {"archived": false, "artifact_type": "learning-resource", "description": "HTTP API design guide extracted from work on the Heroku Platform API", "domain": ["apis", "web-development", "documentation", "developer-tools"], "enriched": true, "function": ["documentation", "api-framework"], "health_score": 20, "homepage": "https://geemus.gitbooks.io/http-api-design/content/en/", "language": null, "license": "NOASSERTION", "license_family": "other", "maturity": "maintenance", "member_repos": ["interagent/http-api-design"], "name": "interagent/http-api-design", "platform": [], "pushed_at": "2024-01-16T20:27:54+00:00", "repo": "interagent/http-api-design", "stars": 13684, "tags": ["http-api", "api-design", "rest", "style-guide", "best-practices", "heroku", "web-server"], "topics": [], "urls": [], "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"], "what_it_is": "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.", "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"], "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)"]}, "data_as_of": "2026-08-30T08:39:29.467469+00:00", "members": [{"path": "/products/http-api-design", "repo": "interagent/http-api-design", "role": "main", "score": 32}], "provenance": {"archived": {"kind": "observed", "observed_at": "2026-08-28T04:11:04.531327+00:00", "source": "github"}, "artifact_type": {"confidence": null, "enriched_at": "2026-08-29T17:13:07.218419+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "d1545e858611db52bdc5bb07a5e494b11e8e5e93d017944dd5c5cdca8475dc3f", "fetched_at": "2026-08-28T04:11:04.531327+00:00", "kind": "readme", "missing": false, "url": "https://github.com/interagent/http-api-design"}], "taxonomy_version": 1}, "description": {"kind": "observed", "observed_at": "2026-08-28T04:11:04.531327+00:00", "source": "github"}, "domain": {"confidence": null, "enriched_at": "2026-08-29T17:13:07.218419+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "d1545e858611db52bdc5bb07a5e494b11e8e5e93d017944dd5c5cdca8475dc3f", "fetched_at": "2026-08-28T04:11:04.531327+00:00", "kind": "readme", "missing": false, "url": "https://github.com/interagent/http-api-design"}], "taxonomy_version": 1}, "enriched": {"inputs": [], "kind": "computed", "method": "enrichment_status"}, "function": {"confidence": null, "enriched_at": "2026-08-29T17:13:07.218419+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "d1545e858611db52bdc5bb07a5e494b11e8e5e93d017944dd5c5cdca8475dc3f", "fetched_at": "2026-08-28T04:11:04.531327+00:00", "kind": "readme", "missing": false, "url": "https://github.com/interagent/http-api-design"}], "taxonomy_version": 1}, "health_score": {"inputs": ["days_since_push", "days_since_release", "archived"], "kind": "computed", "method": "health_v1"}, "homepage": {"kind": "observed", "observed_at": "2026-08-28T04:11:04.531327+00:00", "source": "github"}, "language": {"kind": "observed", "observed_at": "2026-08-28T04:11:04.531327+00:00", "source": "github"}, "license": {"kind": "observed", "observed_at": "2026-08-28T04:11:04.531327+00:00", "source": "github"}, "license_family": {"inputs": ["license"], "kind": "computed", "method": "license_family"}, "maturity": {"confidence": null, "enriched_at": "2026-08-29T17:13:07.218419+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "d1545e858611db52bdc5bb07a5e494b11e8e5e93d017944dd5c5cdca8475dc3f", "fetched_at": "2026-08-28T04:11:04.531327+00:00", "kind": "readme", "missing": false, "url": "https://github.com/interagent/http-api-design"}], "taxonomy_version": 1}, "member_repos": {"kind": "observed", "observed_at": "2026-08-28T04:11:04.531327+00:00", "source": "github"}, "name": {"kind": "observed", "observed_at": "2026-08-28T04:11:04.531327+00:00", "source": "github"}, "platform": {"confidence": null, "enriched_at": "2026-08-29T17:13:07.218419+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "d1545e858611db52bdc5bb07a5e494b11e8e5e93d017944dd5c5cdca8475dc3f", "fetched_at": "2026-08-28T04:11:04.531327+00:00", "kind": "readme", "missing": false, "url": "https://github.com/interagent/http-api-design"}], "taxonomy_version": 1}, "pushed_at": {"kind": "observed", "observed_at": "2026-08-28T04:11:04.531327+00:00", "source": "github"}, "repo": {"kind": "observed", "observed_at": "2026-08-28T04:11:04.531327+00:00", "source": "github"}, "stars": {"kind": "observed", "observed_at": "2026-08-28T04:11:04.531327+00:00", "source": "github"}, "tags": {"confidence": null, "enriched_at": "2026-08-29T17:13:07.218419+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "d1545e858611db52bdc5bb07a5e494b11e8e5e93d017944dd5c5cdca8475dc3f", "fetched_at": "2026-08-28T04:11:04.531327+00:00", "kind": "readme", "missing": false, "url": "https://github.com/interagent/http-api-design"}], "taxonomy_version": 1}, "topics": {"kind": "observed", "observed_at": "2026-08-28T04:11:04.531327+00:00", "source": "github"}, "urls": {"kind": "observed", "observed_at": "2026-08-28T04:11:04.531327+00:00", "source": "github"}, "use_cases": {"confidence": null, "enriched_at": "2026-08-29T17:13:07.218419+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "d1545e858611db52bdc5bb07a5e494b11e8e5e93d017944dd5c5cdca8475dc3f", "fetched_at": "2026-08-28T04:11:04.531327+00:00", "kind": "readme", "missing": false, "url": "https://github.com/interagent/http-api-design"}], "taxonomy_version": 1}, "what_it_is": {"confidence": null, "enriched_at": "2026-08-29T17:13:07.218419+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "d1545e858611db52bdc5bb07a5e494b11e8e5e93d017944dd5c5cdca8475dc3f", "fetched_at": "2026-08-28T04:11:04.531327+00:00", "kind": "readme", "missing": false, "url": "https://github.com/interagent/http-api-design"}], "taxonomy_version": 1}, "when_to_avoid": {"confidence": null, "enriched_at": "2026-08-29T17:13:07.218419+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "d1545e858611db52bdc5bb07a5e494b11e8e5e93d017944dd5c5cdca8475dc3f", "fetched_at": "2026-08-28T04:11:04.531327+00:00", "kind": "readme", "missing": false, "url": "https://github.com/interagent/http-api-design"}], "taxonomy_version": 1}, "when_to_choose": {"confidence": null, "enriched_at": "2026-08-29T17:13:07.218419+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "d1545e858611db52bdc5bb07a5e494b11e8e5e93d017944dd5c5cdca8475dc3f", "fetched_at": "2026-08-28T04:11:04.531327+00:00", "kind": "readme", "missing": false, "url": "https://github.com/interagent/http-api-design"}], "taxonomy_version": 1}}, "score": {"components": {"activity": 0, "longevity": 100, "rhythm": 35}, "computed_at": "2026-09-03T02:20:16.233290+00:00", "flags": ["no_releases", "no_license"], "formula": "round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)", "inputs": {"age_days": 4501, "days_push": 960, "days_rel": null, "gap_med": null, "n_releases_24m": 0}, "score": 32, "version": 2}, "staleness": {"enrichment_outdated": false, "low_confidence": false, "scrape_days": 9, "stale_scrape": false}}