# bolasblack/http-api-guide

Repository: https://github.com/bolasblack/http-api-guide
Canonical: https://ross.abutalabs.com/products/http-api-guide
License: NOASSERTION
License Family: other
Last push: 2025-11-14T21:13:51+00:00

## Health v2 (maintenance only)
Score: 56/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 52, release rhythm 35, longevity 100
- inputs: {"age_days": 4672, "days_push": 292, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases, no_license
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 2553, forks 356 (observed 2026-08-28T04:07:00.599507+00:00)

## What it is
A Chinese-language guide (HTTP 接口设计指北) offering recommendations for designing HTTP APIs, covering the HTTP protocol, URLs, request methods, status codes, authentication, caching, concurrency control, and CORS. It curates RFC references and other API design guidelines as advisory material rather than strict requirements.

## Use cases
- learn how to design restful http apis
- guide for choosing http status codes and request methods
- best practices for api url design
- understand http caching and concurrency control for apis
- reference for http authentication in api design
- api design guidelines in chinese

## When to choose
- you are designing a new HTTP API and want curated best practices with RFC references
- you want a Chinese-language explanation of HTTP API design topics
- you need a starting point linking to authoritative specs like RFC 7230-7235

## When to avoid
- you need an enforceable specification or linting tool rather than advisory suggestions
- you need up-to-date coverage of HTTP/3 or modern API trends
- you want a formal API style guide like Microsoft's or Google's own guidelines

## Facets
- artifact type: learning-resource
- maturity: active
- function: documentation, api-framework
- domain: web-development, apis, documentation, developer-tools
- platform: -
- tags: http-api-design, rest, api-guidelines, chinese-language, reference-guide, web-server

## Member repositories
- bolasblack/http-api-guide (main) score 56

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:07:00.599507+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-30T02:23:47.079120+00:00, confidence not recorded.
  - readme: https://github.com/bolasblack/http-api-guide (fetched 2026-08-28T04:07:00.599507+00:00, sha 38ba812d07a2)
- Data as of 2026-08-30T08:39:29.467469+00:00.