swagger的使用
1.使用swagger-codegen生成server端的controller
两种方式:
- 下载源码,编译,用swagger-codegen-cli.jar命令生成(麻烦,windows)
git clone https://github.com/swagger-api/swagger-codegen
cd swagger-codegen
mvn clean package
java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
-i http://petstore.swagger.io/v2/swagger.json \
-l nodejs-server \
-o samples/server/petstore/nodejs(生成目录)
- 用homebrew安装,用swagger-codegen命令生成(简单,mac)
brew install swagger-codegen
swagger-codegen generate \
-i http://petstore.swagger.io/v2/swagger.json \
-l nodejs-server \
-o tmp/test/
服务器端代码生成后,可通过http://127.0.0.1:port/docs
看到当前api文件生成的UI
注:
-i
表示的输入的yaml或者json文件地址
-l
表示生成的代码类型。例如:nodejs-server
表示用nodejs写的服务端,html
表示客 户端
-o
表示输出文件夹
2.swagger-editor
- 在线编辑:
http://editor.swagger.io/
- 本地编辑:
- 用
git clone https://github.com/swagger-api/swagger-editor.git
将源码下载到本地 cd swagger-editor
http-server -p 8000
- 浏览器登录
http://127.0.0.1:8000
(与在线编辑界面一样)
- 用
3.swagger-ui
- 用
git clone https://github.com/swagger-api/swagger-ui.git
将源码下载到本地 -
cd swagger-ui/dist/
(可将dist目录下的文件拷贝到任意位置,执行下面两步) - 将
index.js
里面引入json文件的url改成你的api的json文件的地址 http-server -p 8000
- 浏览器登录
http://127.0.0.1:8000
可看到在线的API文档