线上第七期_接口管理工具 swagger_20190126

Swagger介绍

Editor

作用

  • 根据open api specification生成文档
  • 交互调试
  • 生成sdk
  • 生成stub

安装

docker pull swaggerapi/swagger-editor
docker run -d -p 9001:8080 swaggerapi/swagger-editor
# 访问 http://127.0.0.1:9001/

UI

docker pull swaggerapi/swagger-ui
docker run -p 9002:8080 swaggerapi/swagger-ui
#http://127.0.0.1:9002

Codegen

作用

  • 自动生成stub server
  • 自动生成各个语言sdk
  • 可以定制代码生成
  • todo:RestAssured的模板

Python Stub Server

unzip python-flask-server-generated.zip
cd python-flask-server
pip3 install -r requirements.txt
python3 -m swagger_server
#访问 http://localhost:8080/v2/ui/

Spring

unzip spring-server-generated.zip
cd spring-server
mvn spring-boot:run 
## http://localhost:8080

插件

  • 从spring或者各个语言的框架中,根据代码自动生成文档

流程

  • OAS -> stub server -> 前端工程师使用
  • OAS -> sdk -> 开发者客户端库
  • OAS -> testing -> 测试工程师使用
  • code -> OAS
  • http -> OAS

参考概念

关闭