Skip to main content

Sphinx domain to mark up RESTful web services in ReST

Project description

Description

Sphinx plugin to add an HTTP domain, allowing the documentation of RESTful HTTP methods.

This is very rudimentary and experimental code at the moment.

HTTP methods

You can document simple methods, wrap any arguments in the path with curly-braces:

.. http:method:: GET /api/foo/bar/{id}/{slug}

   :arg id: An id
   :arg slug: A slug

   Retrieve list of foobars matching given id.

Query string parameters are also supported, both mandatory and optional:

.. http:method:: GET /api/foo/bar/?id&slug

   :param id: An id
   :optparam slug: A slug

   Search for a list of foobars matching given id.

As well, you can provide types for parameters and arguments:

.. http:method:: GET /api/foo/bar/{id}/?slug

   :arg integer id: An id
   :optparam string slug: A slug

   Search for a list of foobars matching given id.

Fragments are also supported:

.. http:method:: GET /#!/username

   :fragment username: A username

   Renders a user's profile page.

Plus, you can document the responses with their response codes:

.. http:method:: POST /api/foo/bar/

   :param string slug: A slug
   :response 201: A foobar was created successfully.
   :response 400:

   Create a foobar.

To refer to an HTTP method, use :http:method::

.. http:method:: GET /api/
   :label-name: get-root
   :title: API root

The :http:method:`get-root` contains all of the API.

HTTP responses

Documenting responses is also simple:

.. http:response:: Foobar object

   A foobar object looks like this::

   .. source-code:: js
      {
         'slug': SLUG
      }

   :data string SLUG: A slug
   :format: JSON

To refer to an HTTP response, use :http:response::

.. http:response:: Foobar object

A :http:response:`foobar-object` is returned when you foo the bar.

Installation

Run pip install sphinx-http-domain.

Then, add sphinx_http_domain to your conf.py:

extensions = ['sphinx_http_domain']

Development

For contributions, please fork this project on GitHub!

Author

David Zentgraf (https://github.com/deceze)

Contributors

Project details


Release history Release notifications

This version
History Node

0.2

History Node

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinx-http-domain-0.2.tar.gz (9.6 kB) Copy SHA256 hash SHA256 Source None Mar 12, 2011

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page