sphinx扩展,它添加了一个简单的按钮来执行对基于json的api的测试调用
sphinxcontrib-jsoncall的Python项目详细描述
json调用
关于
这个扩展添加了一个简单的按钮来执行对 基于json的api还可以更改参数 通过一组输入字段的值。
将显示来自api的json响应 在块中的call按钮下面 json。
它应该与^{tt1}一起使用$ 对文档api的扩展,并提供了使用它们的方法。
cors
请记住,请求是使用ajax调用执行的 因此需要文档和api服务器 在同一域上,或者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=movieidapi 可以使用:
.. 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
此模块在^{tt4}中提供了一个tgjsonautodoc指令$ 给一个涡轮齿轮2应用程序自动检查它寻找 控制器,@exposejson模板并记录其路径, 他们的论据和验证者。方法的docstring被处理 作为特定方法的sphinx段落。
默认情况下,如果在 docstring one自动生成。
使用tgjsonautodoc
要开始使用tgjsonautoc指令,只需将 以下扩展名:
extensions = ['sphinxcontrib.httpdomain', 'sphinxcontrib.jsoncall', 'sphinxcontrib.tgjsonautodoc']
然后必须指定与pastedeploy兼容的配置文件 从加载应用程序的位置:
tgjsonautodoc_app = '/home/myuser/myproject/development.ini'
然后为所有找到的 方法:
.. tgjsonautodoc::