Source

sphinx-contrib / httpdomain / test / index.rst

Full commit

:mod:`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