sphinxcontrib-jsoncall 0.3

关于

此扩展添加了一个简单的按钮，用于执行基于JSON的API的测试调用，同时也允许通过一系列输入字段更改参数值。

API返回的JSON响应将作为美化并加亮的JSON块显示在调用按钮下方。

它旨在与 sphinxcontrib.httpdomain 扩展结合使用，以记录API并提供与其交互的方式。

使用方法

首先，您必须将扩展添加到conf.py中扩展列表

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

现在，只需提供API调用的基本URL即可开始使用jsoncall指令

jsoncall_baseurl = 'http://somwhere.com/api'

指令

此模块定义了一个指令 jsoncall，该指令接受一个必需的参数，即API的URL，相对于 jsoncall_baseurl

.. jsoncall:: /publicapitest

还可以通过指令的内容提供API调用的一组参数。内容本身需要是一个包含所有参数的JSON字典。

假设我们有一个 /movies/retrieve?id=movieid API，它将能够通过以下方式对其进行测试

.. jsoncall:: /movies/retrieve

      {"id": "505c6a9d93681621aa0000fe"}

这还将添加一个 id 输入字段，允许修改id值以尝试不同的API调用。

可以在响应字段中手动插入响应，只需将其写在输入字段下方即可。

.. jsoncall:: /movies/retrieve

      {"id": "505c6a9d93681621aa0000fe"}

      {"title": "The Hitchhiker's Guide to the Galaxy"}

样式化

扩展提供了一个默认的CSS文件，可以使用 jsoncall_inject_css 选项禁用它。

使用 TGJsonAutodoc

要开始使用 tgjsonautod 指令，只需将以下扩展添加到您的 conf.py 文件中

extensions = ['sphinxcontrib.httpdomain', 'sphinxcontrib.jsoncall', 'sphinxcontrib.tgjsonautodoc']

然后您必须指定与 PasteDeploy 兼容的配置文件，您的应用程序将从该配置文件加载

tgjsonautodoc_app = '/home/myuser/myproject/development.ini'

然后指定您要为所有找到的方法生成文档的位置

.. tgjsonautodoc::