Skip to main content

Adds example directive for sphinx-contrib httpdomain

Project description

sphinxcontrib-httpexample

https://github.com/collective/sphinxcontrib-httpexample/actions/workflows/build.yml/badge.svg?branch=master 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

Examples

This extension has been used at least in the following documentations:

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

1.3 (2024-08-18)

1.2 (2024-08-17)

  • Add new HTTP example builder plone-javascript [datakurre]

  • Fix tabbing to no longer depend on jQuery [datakurre]

  • Fix tabbing to support arrow key navigation [datakurre]

  • Fix tab key to stop at tab list only once [datakurre]

  • Fix requests builder to flatten simple values in form data [datakurre]

  • Fix requests builder to pass form data as dictionary [datakurre]

  • Change JavaScript-based tabbing to no longer require JQuery [datakurre]

1.1 (2021-12-25)

  • Add support for docutils 0.17.x [kvondersaar, datakurre]

  • Add support for Python 3.8 [datakurre]

  • Fix example tabs accessibility [datakurre]

1.0 (2021-09-10)

  • The curl command builder will now always specify a method [LefterisJP]

0.11.0 (2021-05-14)

  • Change to quote examples with “ rather than ‘ [datakurre]

  • Fix Sphinx deprecation warnings and support Sphinx 4.x] [kkrypt0nn, AWhetter]

  • Fix to use ast.unparse instead astunparse on Python >= 3.9 [datakurre]

0.10.3 (2019-05-01)

  • Re-release 0.10.2 with wheel [datakurre]

0.10.2 (2019-05-01)

  • Add support for inline response examples without HTTP version (e.g. HTTP 200 OK) [datakurre]

  • Fix regression where support for reading request examples from external files was broken since 0.10.0 [datakurre]

0.10.1 (2019-03-19)

  • Fix issue where it was not possible to request exmples with float values in payload JSON [fixes #42] [datakurre]

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.

Source Distribution

sphinxcontrib-httpexample-1.3.tar.gz (33.9 kB view details)

Uploaded Source

Built Distribution

sphinxcontrib_httpexample-1.3-py2.py3-none-any.whl (14.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sphinxcontrib-httpexample-1.3.tar.gz.

File metadata

  • Download URL: sphinxcontrib-httpexample-1.3.tar.gz
  • Upload date:
  • Size: 33.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.3.1.post20210326 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.10

File hashes

Hashes for sphinxcontrib-httpexample-1.3.tar.gz
Algorithm Hash digest
SHA256 05999d36dd4a91f1146a3c9f5cd1faf721b8960ba3d4ee6d951b1a80cec0ea8f
MD5 bb14a49f3a4fa64e93eec2978444072e
BLAKE2b-256 b1de4e26a2e72ba562b8498ca0ac3e32841c5727b07740913bfe3149dfbc3168

See more details on using hashes here.

File details

Details for the file sphinxcontrib_httpexample-1.3-py2.py3-none-any.whl.

File metadata

  • Download URL: sphinxcontrib_httpexample-1.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 14.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.3.1.post20210326 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.10

File hashes

Hashes for sphinxcontrib_httpexample-1.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 052ca596b487f5363b8496712e52ae46d48f92cb3103c691ba1e81ec720b4b14
MD5 d145faac1c9b5f9293763050d9351c01
BLAKE2b-256 061b9259981370ac1cc0a772050af1fc52e8b0e101d1ec69eaae4d0a2a3c9189

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page