帮酷LOGO
0 0 评论
文章标签:falcon  Generator  Flask  fal  WEB  SAN  TOR  Tornado  
Flask RESTful Application Code Generator

  • 源代码名称:swagger-py-codegen
  • 源代码网址:http://www.github.com/guokr/swagger-py-codegen
  • swagger-py-codegen源代码文档
  • swagger-py-codegen源代码下载
  • Git URL:
    git://www.github.com/guokr/swagger-py-codegen.git
  • Git Clone代码到本地:
    git clone http://www.github.com/guokr/swagger-py-codegen
  • Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/guokr/swagger-py-codegen
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
    
  • python RESTful Web框架生成器

    Build StatusPyPi Version

    概述

    Swagger是python web框架生成器,它可以帮助你根据给定的Swagger规范文档自动生成python web框架,目前,支持以下语言/框架:

    Alpha版本目前可能无法正确处理所有验证,如果你发现了错误,请与我们联系。

    安装

    
    pip install swagger-py-codegen
    
    
    
    

    用法

    创建全部:

    
    swagger_py_codegen --swagger-doc api.yml example-app
    
    
    
    

    命令选项:

    
    -s, --swagger, --swagger-doc Swagger doc file. [required]
    
    
    -f, --force Force overwrite.
    
    
    -p, --package Package name / application name.
    
    
    -t, --template-dir Path of your custom templates directory.
    
    
    --spec, --specification Generate online specification json response.
    
    
    --ui Generate swagger ui.
    
    
    -tlp, --templates gen flask/tornado/falcon templates, default flask.
    
    
    --version Show current version.
    
    
    --help Show this message and exit.
    
    
    
    

    例子:

    从以下位置生成例子应用程序api.yml

    Flask例子
    
    $ swagger_py_codegen -s api.yml example-app -p demo
    
    
    $ tree (flask-demo)
    
    
    .
    
    
    |__ api.yml
    
    
    |__ example-app
    
    
     |__ demo
    
    
     | |__ __init__.py
    
    
     | |__ v1
    
    
     | |__ api
    
    
     | | |__ __init__.py
    
    
     | | |__ pets.py
    
    
     | | |__ pets_petId.py
    
    
     | |__ __init__.py
    
    
     | |__ routes.py
    
    
     | |__ schemas.py
    
    
     | |__ validators.py
    
    
     |__ requirements.txt
    
    
    
    
    Tornado例子
    
    $ swagger_py_codegen -s api.yml example-app -p demo -tlp=tornado
    
    
    $ tree (tornado-demo)
    
    
    .
    
    
    |__ api.yml
    
    
    |__ example-app
    
    
     |__ demo
    
    
     | |__ __init__.py
    
    
     | |__ core
    
    
     | |__ __init.py
    
    
     | |__ v1
    
    
     | |__ api
    
    
     | | |__ __init__.py
    
    
     | | |__ pets.py
    
    
     | | |__ pets_petId.py
    
    
     | |__ __init__.py
    
    
     | |__ routes.py
    
    
     | |__ schemas.py
    
    
     | |__ validators.py
    
    
     |__ requirements.txt
    
    
    
    
    猎鹰例子
    
    $ swagger_py_codegen -s api.yml example-app -p demo -tlp=falcon
    
    
    $ tree (falcon-demo)
    
    
    .
    
    
    |__ api.yml
    
    
    |__ example-app
    
    
     |__ demo
    
    
     | |__ __init__.py
    
    
     | |__ v1
    
    
     | |__ api
    
    
     | | |__ __init__.py
    
    
     | | |__ pets.py
    
    
     | | |__ pets_petId.py
    
    
     | |__ __init__.py
    
    
     | |__ routes.py
    
    
     | |__ schemas.py
    
    
     | |__ validators.py
    
    
     |__ requirements.txt
    
    
    
    
    Sanic例子
    
    $ swagger_py_codegen -s api.yml example-app -p demo -tlp=sanic
    
    
    $ tree (sanic-demo)
    
    
    .
    
    
    |__ api.yml
    
    
    |__ example-app
    
    
     |__ demo
    
    
     | |__ __init__.py
    
    
     | |__ v1
    
    
     | |__ api
    
    
     | | |__ __init__.py
    
    
     | | |__ pets.py
    
    
     | | |__ pets_petId.py
    
    
     | |__ __init__.py
    
    
     | |__ routes.py
    
    
     | |__ schemas.py
    
    
     | |__ validators.py
    
    
     |__ requirements.txt
    
    
    
    
    运行Web 网络服务器

    安装例子应用程序要求:

    
    $ cd example-app
    
    
    $ pip install -r requirements.txt
    
    
    
    

    启动例子应用程序:

    
    $ cd demo
    
    
    $ python __init__.py
    
    
    
    

    并使用ui从api ,yml生成例子app ui:

    
    $ swagger_py_codegen -s api.yml example-app-ui -p demo-ui --ui --spec
    
    
    
    

    然后你可以在浏览器中访问http://127.0.0.1:5000/static/swagger-ui/index.html

    OAuth2用法

    查看维基

    兼容性

    组件兼容性
    OpenAPI规范 2.0
    python 2.* ,3.*(Sanic only 3.* )

    作者

    查看AUTHORS

    许可证

    MIT



    文章标签:WEB    SUP  Generator  TOR  Flask  SAN  fal  

    Copyright © 2011 HelpLib All rights reserved.    知识分享协议 京ICP备05059198号-3  |  如果智培  |  酷兔英语