sphinxcontrib.httpdomain — Documenting RESTful HTTP APIs

Directives

Sourcecode

GET /users/123/posts/web HTTP/1.1
Host: example.com
Accept: application/json, text/javascript

HTTP/1.1 200 OK
Vary: Accept
Content-Type: text/javascript

[
  {
    "post_id": 12345,
    "author_id": 123,
    "tags": ["server", "web"],
    "subject": "I tried Nginx"
  },
  {
    "post_id": 12346,
    "author_id": 123,
    "tags": ["html5", "standards", "web"],
    "subject": "We go to HTML 5"
  }
]

Resource fields

Options

Roles

Referring to existing directives

:http:patch:`/users/(int:user_id)/posts/(tag)`

:http:options:`/users/(int:user_id)/posts/(tag)`

:http:get:`/users/(int:user_id)/posts/(tag)`

:http:head:`/users/(int:user_id)/posts/(tag)`

:http:post:`/users/(int:user_id)/posts/(tag)`

:http:put:`/users/(int:user_id)/posts/(tag)`

:http:delete:`/users/(int:user_id)/posts/(tag)`

:http:trace:`/users/(int:user_id)/posts/(tag)`

:http:connect:`/users/(int:user_id)/posts/(tag)`

Method roles

:http:method:`patch`

:http:method:`options`

:http:method:`get`

:http:method:`head`

:http:method:`post`

:http:method:`put`

:http:method:`delete`

:http:method:`trace`

:http:method:`connect`

Here be Errors!

A request with method :http:method:`foo` followed by :http:header:`bar` and :http:header:`x-baz` headers receives response with :http:statuscode:`42 Answer` status code.

sphinxcontrib.autohttp.flask — Exporting API reference from Flask app

Basic option

Basic option with empty args

Basic option with ordering by path

Filter some endpoints

Method View

Grouped Method View

Documenting by non-ASCII characters