从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如何通过编程将Android置于待机状态?   java mavenjarsignerplugin在Jenkins构建期间失败,但不是在命令行上   java创建具有公共ipv4地址的HttpServer   将数据从jsp传递到servlet的java返回null   Web应用程序中的java JDBC数据库连接   java无法显示unicode字符   java webview应用程序未上载图片或视频   Android客户端Java服务器,如果订单处理方式不正确,客户端将无法连接   java在不复制备份表的情况下创建备份表   集合如何在Java中实现列表折叠   java如何配置在JBoss7中使用EntityListeners?   java JVM ClassUnloadingWithConcurrentMark标志   java如何在Maven中排除特定的单元测试   java线程在SynchronousQueue中执行put操作后挂起   java中的hibernate Comparator和可比较的负面场景   数组中的java连接元素   拖放Java,让面板落在鼠标事件上   java是一种事务管理应用程序,无需在方法上使用@transactional   java有没有办法从安卓的软键板上删除这一行?