渲染部分规范的框架

时间:2018-12-11 12:07:42

标签: swagger markdown

我的API文档由3个主要元素组成-生成的swagger.json规范,API参考,该参考只是使用ReDoc渲染为swagger.json以及手写的markdown文档以及有关如何使用它的指南。

我希望在手写文档中包含部分呈现的API参考,并且它将保持最新状态。因此,例如,将有一份有关如何进行身份验证的手写指南,其中将包括一个带有

的表格

我最初的想法是扩展markdown解析器以包括自定义标签,例如[[url.com/swagger.json][/endpointToRender]]之类的东西,它将呈现有关端点的信息,例如:ReDoc

我希望这样的东西已经存在,但是我找不到它。

0 个答案:

没有答案