swagger-py-codegen生成flask api代码

swagger codegen

阅读本文, 将会了解:

• pip 安装swagger-py-codegen
• swagger-py-codegen生成flask代码

install swagger-py-codegen

• pip install swagger-py-codegen

swagger api yaml

打开swagger editor官网, 会默认有个api的example, copy内容到api.yaml文件中。
如果没有内容, 删除浏览器的缓存后刷新试试

• 官网： https://editor.swagger.io/#/

swagger_py_codegen生成flask的demo

• swagger_py_codegen --swagger-doc api.yaml demos --ui --spec --force

C:\work\swagger_py_codegen
(swagger_py_codegen) λ swagger_py_codegen --swagger-doc api.yaml demos --ui --spec --force
generate    demos\demos/static/swagger-ui
generate    demos\demos/v2/schemas.py
generate    demos\demos/v2/routes.py
generate    demos\demos/v2/api/pet.py
generate    demos\demos/v2/api/pet_findByStatus.py
generate    demos\demos/v2/api/pet_findByTags.py
generate    demos\demos/v2/api/pet_petId.py
generate    demos\demos/v2/api/pet_petId_uploadImage.py
generate    demos\demos/v2/api/store_inventory.py
generate    demos\demos/v2/api/store_order.py
generate    demos\demos/v2/api/store_order_orderId.py
generate    demos\demos/v2/api/user.py
generate    demos\demos/v2/api/user_createWithArray.py
generate    demos\demos/v2/api/user_createWithList.py
generate    demos\demos/v2/api/user_login.py
generate    demos\demos/v2/api/user_logout.py
generate    demos\demos/v2/api/user_username.py
generate    demos\demos/static/v2/swagger.json
generate    demos\demos/v2/validators.py
generate    demos\demos/v2/api/__init__.py
generate    demos\demos/v2/__init__.py
generate    demos\demos/__init__.py
generate    demos\requirements.txt
generate    demos\demos/static/swagger-ui/index.html

swagger_py_codegen参数

• 查看参数: swagger_py_codegen.exe --help

参考链接

• swagger-py-codegen 官网: https://github.com/guokr/swagger-py-codegen
• swagger-editor： https://editor.swagger.io/#/

总结

- pip install swagger-py-codegen
- 生成api.yaml
- swagger_py_codegen --swagger-doc api.yaml demos --ui --spec --force
- cd demos
- pip install -r requirements.txt
- python __init__.py
- 浏览器打开：http://127.0.0.1:5000/static/swagger-ui/index.html

扫码关注公众号: 风起帆扬了
一起学习，一起成长，一起分享
行走在测试大道上