Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

Adds example directive for sphinx-contrib httpdomain

Project description

sphinxcontrib-httpexample

https://secure.travis-ci.org/collective/sphinxcontrib-httpexample.png https://coveralls.io/repos/github/collective/sphinxcontrib-httpexample/badge.svg?branch=master https://badge.fury.io/py/sphinxcontrib-httpexample.svg https://readthedocs.org/projects/sphinxcontrib-httpexample/badge/?version=latest

sphinxcontrib-httpexample enhances sphinxcontrib-httpdomain, a Sphinx domain extension for describing RESTful HTTP APIs in detail, with a simple call example directive. The new directive provided by this extension generates RESTful HTTP API call examples for different tools from a single HTTP request example.

The audience for this extension are developers and technical writes documenting their RESTful HTTP APIs. This extension has originally been developed for documenting plone.restapi.

Features

Documentation

Full documentation for end users can be found in the “docs” folder. It is also available online at http://sphinxcontrib-httpexample.readthedocs.org/

Installation

Add sphinxcontrib-httpexample into requirements of your product documentation and into the configuration file of your Sphinx documentation next to sphincontrib-httpdomain as follows:

extensions = ['sphinxcontrib.httpdomain', 'sphinxcontrib.httpexample']

License

The project is licensed under the GPLv2.

Changelog

0.10.0 (2018-10-09)

  • Add support of the URL query parameters, using the query field. Given a line :query param_name: param_value in an http example directive, the key value pair param_name, param_value will be added to the request URL (and excluded from further processing). [ludaavics]

    Example:

    GET /items HTTP/1.1
    Host: localhost
    Accept: application/json
    Authorization: Basic dXNlcjpwYXNzd29yZA==
    
    :query from: 20170101
    :query to: 20171231
    :query user_id: 12
    :query limit: 20
    :query sort: date(asc)
    

0.9.1 (2018-10-06)

  • Fix packaging to include setup.cfg in sdist [datakurre]
  • Add the guillotina docs (which now uses httpexample) [cdevienne]

0.9.0 (2018-07-22)

  • Add support for inlining responses [cdevienne]

0.8.1 (2018-06-27)

  • Fixed error when parsing top level json lists [AWhetter]

0.8.0 (2017-11-18)

  • Fix to not strip out Accept/Content-Type headers in builders [dokai]
  • Improve logic to detect a JSON content type [dokai]
  • Use redirected input to pass request payload to httpie [dokai]
  • Fix quoting of non-trivial HTTP headers in builders [dokai]
  • Change to use declarative packaging (setup.cfg instead of setup.py) [datakurre]

0.7.0 (2017-10-21)

  • Allow the URL scheme (http or https) to be configured [dokai]
  • Quote the URL if it contains & characters in curl/httpie/wget examples [dokai]

0.6.1 (2017-05-11)

  • Release as universal wheel [datakurre]

0.6.0 (2017-05-11)

  • Support non-json requests [jaroel]
  • Support application/json; charset=utf-8 [skyzyx]

0.5.2 (2017-03-09)

  • Fix packaging to include the files in static #3 [csenger]

0.5.1 (2017-03-05)

  • Update README and documentation [datakurre]

0.5.0 (2017-03-05)

  • Change development status to beta [datakurre]

0.4.2 (2017-03-05)

  • Fix issue where wget basic auth required challenge from backend, which is not always available [datakurre]

0.4.1 (2017-03-05)

  • Fix issue where generate httpie-commands did not always set Accept and Content-Type -headers [datakurre]

0.4.0 (2017-03-05)

  • Add support for wget [datakurre]

0.3.0 (2017-03-05)

  • Add generic ‘Authorization’-header support [datakurre]

0.2.1 (2017-03-05)

  • Fix issue where Authorization-header was always requires [datakurre]
  • Fix raise proper exception when parsing bad requests [datakurre]
  • Fix issue where httpie-builder did not quote values with spaces [datakurre]
  • Fix link to python-requests’ documentation [datakurre]

0.2.0 (2017-03-05)

  • Add support for GET requests [datakurre]

0.1.0 (2017-03-05)

  • First release [datakurre]

Project details


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
sphinxcontrib_httpexample-0.10.0-py2.py3-none-any.whl (15.2 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Oct 9, 2018
sphinxcontrib-httpexample-0.10.0.tar.gz (33.0 kB) Copy SHA256 hash SHA256 Source None Oct 9, 2018

Supported by

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