Sphinx扩展，支持OpenStack API参考网站
项目描述
os-api-ref
Sphinx扩展，支持OpenStack API参考网站
此项目是一个RST中用于构建OpenStack项目API参考网站的sphinx段落的集合。RST非常适合非结构化英语，但在表格中显示半结构化（且重复）的数据并不是它的强项。这提供了工具，可以将描述请求和响应参数以及状态或错误消息的半结构化数据插入其中，并将其转换为漂亮的表格。
该项目还包括一组样式（和javascript），它预期将叠加在Sphinx主题基础上。此添加提供了一组用于REST方法的折叠部分，以及用于展开/折叠所有部分的javascript控件。
功能
Sphinx段落 rest_method，用于描述REST API调用的方法和资源。让作者可以简单地编写，同时也为读者提供了一个干净的方式来扫描所有方法，然后点击按钮以获取有关方法的更多信息。
Sphinx段落 rest_parameters，用于将半结构化数据插入到RST文件中，描述用户可以与请求一起发送的参数。段落指向结构化的YAML文件，parameters.yaml。
Sphinx段落 rest_status_code，用于插入服务返回的错误或状态码的指针。指向结构化的YAML文件，http_codes.yaml。
待办事项
这是一个项目中的待办事项列表，没有特定的顺序。如果您想为其中任何一项做出贡献，请在IRC的#openstack-dev频道中找到sdague或mugsie进行讨论，或者发送带有[api]主题行的邮件至openstack-discuss@lists.openstack.org列表。
增强文档，添加更多示例和最佳实践
对代码进行测试
支持max_microversion参数 - 以便我们自动标记已删除的参数
制作一个微版本选择器，以便您可以得到一个隐藏了所有高于所选版本的微版本元素的api-ref版本（这将是一个有点复杂的javascript），正在进行中。
潜在的想法
这些甚至不是真正的待办事项，只是关于可能有用的事情的想法。
.. literalinclude 对于包含API样本文件的文件来说很好，但我们是否应该有更多包含完整的REST /URL的标记。
Sphinx段落
rest_method：输入REST方法，如GET、PUT、POST、DELETE，后跟调用资源（不包括端点）。例如
.. rest_method:: PUT /v2/images/{image_id}/file
rest_parameters：输入一个指向parameters.yaml文件的引用，并指明您想文档化的参数。例如
.. rest_parameters:: images-parameters.yaml - Content-type: Content-Type-data - image_id: image_id-in-path
其中images-parameters.yaml文件包含名为Content-type和image_id的指针以及每个的描述。
rest_status_code：输入一个指向http-status.yaml文件的引用，并指明您想文档化的错误或状态码。您还可以添加指向每个代码的更精确描述的指针。例如
.. rest_status_code:: success http-codes.yaml - 204 .. rest_status_code:: error http-codes.yaml - 400: informal - 401 - 403 - 404 - 409 - 410: image-data-410 - 413: image-data-413 - 415: image-data-415 - 500: informal - 503: image-data-503
自由软件：Apache许可证
下载文件
下载您平台上的文件。如果您不确定选择哪个，请了解更多关于安装包的信息。