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目錄下的文件拷貝到任意位置盾鳞,執(zhí)行下面兩步) - 將
index.js
里面引入json文件的url改成你的api的json文件的地址 http-server -p 8000
- 瀏覽器登錄
http://127.0.0.1:8000
可看到在線的API文檔