swagger-py-codegen生成flask api代碼

文章目錄

• • swagger codegen
  • • install swagger-py-codegen
    • swagger api yaml
    • swagger_py_codegen生成flask的demo
    • swagger_py_codegen參數
  • 參考連結
  • 總結

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
           

掃碼關注公衆号: 風起帆揚了

一起學習，一起成長，一起分享

行走在測試大道上