swagger在node.js下的使用

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文檔