从swagger到sphinx http域的转换器。

sphinxcontrib-swagger2sphinx的Python项目详细描述


Swagger是一个用json或yaml编写restapi文档的开放规范。 尽管它不完美,但事实上它是许多api开发人员的标准。

此扩展允许您将swagger.json文件呈现为sphinx文档。 它对paths使用HTTP domain指令,对definitions使用词汇表。

警告

此扩展是为特定项目创建的,因此仅 保证与这个特殊的项目合作!很有可能 您必须为项目修改swagger-api.rst

用法

  1. 安装延长件:

    $ pip install sphinxcontrib-swagger2sphinx
    
  2. swagger-api.rst的内容复制到所需的文件中 你的大摇大摆的文件呈现。

  3. 将扩展名添加到您的conf.py

    extensions = [
        'sphinxcontrib.swagger2sphinx',
        ...
    ]
    
  4. conf.py中指定您的swagger文件的路径。可能是本地的 路径或URL:

    swagger2sphinx_swagger_location="swagger.json"# swagger2sphinx_swagger_location = "http://example.com/swagger.json"

推荐信

感谢eric holscher写了关于扩展的an excellent blog post 狮身人面像和金贾2模板。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java FirebaseInstanceId。getInstance()始终为空   linux Java执行文件错误   javaspringboot:如何使用Ajax在springboot和Thymeleaf中创建进度条?   java禁用在安卓上使用传单时启用setJavaScriptEnabled   java如何在主体中发布原始类型JSON数据?   消除JAVA While循环中的额外输出   如何在java中直接将基本数据类型分配给自定义类   java为什么addNode()方法返回编译错误“类型中的方法…不适用于参数…”,我该如何修复它?   java惰性合成可观察对象   eclipse Java Blackberry位图单击   java Android:AsyncTask对象[]无法在doInBackground中强制转换   java有没有办法重构或改进这段代码?   java如何使用系统以十六进制打印字节。出来普林顿?   多线程如何在我的java聊天室中调试“java.net.UnknownHostException”?   java如何从Google App Engine下载应用程序源文件   java如何在Spring Data Mongo的聚合$group中使用类似$dateToString   java IBM websphere application server未在MyEclipse8中启动。0