Swagger-editor and Swagger-ui in Docker

除了可以在线编辑swaggerAPI文档,还可以通过容器在本地进行编辑,并且也提供了swagger-ui的容器可以根据你写的json文件生成UI页面,方便前端童鞋的使用。这个是目前最简单的方法!~

1)下载swagger-editor的容器

docker pull swaggerapi/swagger-editor 
docker run -d -p 81:8080 swaggerapi/swagger-editor 

81:8080 将容器的8080端口暴露给localhost的81端口,在浏览中输入:localhost:81,就可以在容器中编辑api文档

编辑后,在页面上上方点击 File -> Download JSON,将文件下载到本地(/Users/fanfan/Downloads)命名为swagger.json

2)下载swagger-ui的容器

docker pull swaggerapi/swagger-ui 
Swagger-editor and Swagger-ui in Docker_第1张图片
images

3)json文件挂在到容器中

docker run -p 80:8080 -e SWAGGER_JSON=/foo/swagger.json -v /Users/fanfan/Downloads:/foo swaggerapi/swagger-ui 

-e:执行容器中/foo/swagger.json
-v:将/Users/fanfan/Downloads中的swagger.json挂在到 /foo中执行
没有将swagger.json 在容器内修改的好处:在外部修改后容器可以直接运行,如果在容器内容修改需要在compile一次生成新的容器,这就复杂了哈

4)web验证
输入:localhost:80


Swagger-editor and Swagger-ui in Docker_第2张图片
images

你可能感兴趣的:(Swagger-editor and Swagger-ui in Docker)