sphinxcontrib-httpexample 1.3

功能

• 指令用于从单个HTTP请求生成各种RESTful HTTP API调用示例。

• 支持的工具

  • curl

  • wget

  • httpie

  • python-requests

示例

此扩展至少被以下文档使用

• http://plonerestapi.readthedocs.org/

• http://sphinxcontrib-httpexample.readthedocs.org/

• https://guillotina.readthedocs.io/en/latest/

文档

完整用户文档可在“docs”文件夹中找到。它也在线上可用，地址为http://sphinxcontrib-httpexample.readthedocs.org/

安装

将sphinxcontrib-httpexample添加到您产品文档的要求中，并在Sphinx文档配置文件中将sphincontrib-httpdomain旁边的sphinxcontrib-httpexample配置如下

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

许可协议

本项目采用GPLv2许可。

1.3 (2024-08-18)

• 添加了新的指令.. http:example-block::，以允许与Sphinx标签库（如sphinx-inline-tabs或sphinx-design）一起使用。[AWhetter]

1.2 (2024-08-17)

• 添加了新的HTTP示例构建器plone-javascript [datakurre]

• 修复了分页，不再依赖于jQuery [datakurre]

• 修复了分页，支持箭头键导航 [datakurre]

• 修复了Tab键在标签列表中只停止一次的问题 [datakurre]

• 修复了requests构建器，以在表单数据中扁平化简单值 [datakurre]

• 修复了requests构建器，以将表单数据作为字典传递 [datakurre]

• 将基于JavaScript的分页修改为不再需要JQuery [datakurre]

1.1 (2021-12-25)

• 添加了对docutils 0.17.x的支持 [kvondersaar, datakurre]

• 添加了对Python 3.8的支持 [datakurre]

• 修复了示例标签的可用性问题 [datakurre]

1.0 (2021-09-10)

• curl命令构建器现在将始终指定一个方法 [LefterisJP]

0.11.0 (2021-05-14)

• 修改为使用“”而不是“'”引号示例 [datakurre]

• 修复了Sphinx弃用警告并支持Sphinx 4.x] [kkrypt0nn, AWhetter]

• 修复了在Python >= 3.9上使用ast.unparse而不是astunparse的问题 [datakurre]

0.10.3 (2019-05-01)

• 重新发布0.10.2版本，包含wheel [datakurre]

0.10.2 (2019-05-01)

• 添加了对不包含HTTP版本（例如，HTTP 200 OK）的内联响应示例的支持 [datakurre]

• 修复了自0.10.0以来读取请求示例的从外部文件支持中断的回归问题 [datakurre]

0.10.1 (2019-03-19)

• 修复了无法请求带有浮点值的有效载荷JSON的示例的问题 [fixes #42] [datakurre]

0.10.0 (2018-10-09)

• 添加了对URL查询参数的支持，使用query字段。给定一个http示例指令中的行:query param_name: param_value，键值对param_name，param_value将被添加到请求URL中（并从进一步处理中排除）。 [ludaavics]

  示例

  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)

• 修复了打包问题，以包括sdist中的setup.cfg [datakurre]

• 添加了guillotina文档（现在使用httpexample） [cdevienne]

0.9.0 (2018-07-22)

• 添加了对内联响应的支持 [cdevienne]

0.8.1 (2018-06-27)

• 修复了解析顶层json列表时的错误 [AWhetter]

0.8.0 (2017-11-18)

• 修复了在构建器中不删除Accept/Content-Type标头的错误 [dokai]

• 改进了检测JSON内容类型的逻辑 [dokai]

• 使用重定向输入将请求有效载荷传递给httpie [dokai]

• 修复了构建器中非平凡HTTP标头的引号问题 [dokai]

• 修改为使用声明性打包（setup.cfg而不是setup.py） [datakurre]

0.7.0 (2017-10-21)

• 允许配置URL方案（http或https） [dokai]

• 在curl/httpie/wget示例中将包含&字符的URL引号 [dokai]

0.6.1 (2017-05-11)

• 作为通用wheel发布 [datakurre]

0.6.0 (2017-05-11)

• 支持非JSON请求 [jaroel]

• 支持application/json; charset=utf-8 [skyzyx]

0.5.2 (2017-03-09)

• 修复打包问题，包括静态文件 #3 [csenger]

0.5.1 (2017-03-05)

• 更新 README 和文档 [datakurre]

0.5.0 (2017-03-05)

• 将开发状态更改为测试版 [datakurre]

0.4.2 (2017-03-05)

• 修复了 wget 基本认证需要从后端获取挑战的问题，这并不总是可用 [datakurre]

0.4.1 (2017-03-05)

• 修复了 generate httpie-commands 没有总是设置 Accept 和 Content-Type 头部的问题 [datakurre]

0.4.0 (2017-03-05)

• 添加对 wget 的支持 [datakurre]

0.3.0 (2017-03-05)

• 添加通用的 'Authorization' 头部支持 [datakurre]

0.2.1 (2017-03-05)

• 修复了 Authorization 头部总是需要的问题 [datakurre]

• 修复了解析不良请求时引发适当的异常 [datakurre]

• 修复了 httpie-builder 没有引用包含空格的值 [datakurre]

• 修复链接到 python-requests 的文档 [datakurre]

0.2.0 (2017-03-05)

• 添加对 GET 请求的支持 [datakurre]

0.1.0 (2017-03-05)

• 第一个版本 [datakurre]