SwaggerUI是一個非常好用的API文檔工具,最關鍵的是他還能在工具內調試API,簡直爽的不要不要的~網上針對開發者的文檔非常多,但是給用戶的手冊卻非常少。所以我來簡單寫個用戶手冊,供沒有使用過swaggerUI的同仁們參考。
一、UI各部件說明
如下面兩張圖所示:
Swagger會對API進行分組,每個分組下面會包含多個API,API中各個Requet/Response參數都可以在界面中看到,並且可以在文本框中輸入你的請求參數,並點擊try it out! 來獲取api的返回結果。
好,重點看圖吧~