---
id: sphinxcontrib-httpdomain
version: "2.0.0"
license: BSD-2-Clause
license_treatment: permissive
maintenance: aging
---

# sphinxcontrib-httpdomain — Sphinx extension that provides a domain for documenting HTTP APIs.

License: permissive · Maintenance: aging · Downloads: 3.5M/mo

## What it is and what it does

sphinxcontrib-httpdomain is a Sphinx extension that adds a domain for documenting HTTP APIs. It lets you use structured markup directives to describe HTTP endpoints, methods, parameters, and responses within Sphinx documentation, generating cross-referenced API reference pages.

The package depends only on sphinx and installs with low friction. It's classified as Production/Stable and supports Python 3.10 through 3.14. However, maintenance is aging—the last release was 191 days ago—so while it works with current Python versions, you should verify that its HTTP domain syntax and feature set align with your documentation workflow before adopting it for new projects.

Use it for:

- Generate structured API reference documentation for REST services within Sphinx projects.
- Document HTTP endpoints with method signatures, parameters, and response codes in a single domain.
- Cross-reference HTTP resources and endpoints within larger technical documentation.
- Build API docs that integrate with existing Sphinx-based project documentation.
- Maintain HTTP API documentation alongside other project docs in version control.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Provides a Sphinx domain for documenting HTTP APIs with structured markup and cross-referencing support.

Yes, if you are already using Sphinx and need HTTP API documentation markup. The low install friction, permissive license, and Production/Stable status make it a straightforward choice for Sphinx-based projects. However, verify that its feature set and syntax match your API documentation needs, and be aware that maintenance is aging—check whether active alternatives or community forks better suit modern workflows.

## Install

pip install sphinxcontrib-httpdomain
uv add sphinxcontrib-httpdomain
poetry add sphinxcontrib-httpdomain

## Installing sphinxcontrib-httpdomain

Before you install: Low friction install with a single runtime dependency on sphinx. Maintenance status is aging (191 days since last release), though the package is marked Production/Stable and supports current Python versions through 3.14.

License in practice: BSD-2-Clause permissive license allows commercial and private use with minimal restrictions.

Quickstart:

pip install sphinxcontrib-httpdomain

# In conf.py:
extensions = ['sphinxcontrib.httpdomain']

# In .rst file:
.. http:get:: /api/users
   :synopsis: Retrieve user list

Requires Sphinx to be installed and a Sphinx project structure (conf.py, .rst files).

Verify before relying:

- Whether the HTTP domain syntax and features remain compatible with recent Sphinx versions despite aging maintenance status.
- Whether this package is actively maintained or if community forks have superseded it for modern API documentation workflows.

## Package facts

- License: BSD-2-Clause (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: aging
- Downloads: 3.5M/month (top 5,000 on PyPI)
- Known vulnerabilities: none known

## Tags

sphinx http api documentation, sphinx domain http, document rest api sphinx, http endpoint documentation, api reference sphinx extension, sphinx http domain, rest api docs sphinx, sphinx-extension, api-documentation, http-domain

[View on SkillFed](https://skillfed.io/packages/sphinxcontrib-httpdomain) · [View on PyPI](https://pypi.org/project/sphinxcontrib-httpdomain/)