【轉載】swagger是什么?
Swagger 是一個規范和完整的框架,用于生成、描述、調用和可視化 RESTful 風格的 Web 服務的接口文檔。
目前的項目基本都是前后端分離,后端為前端提供接口的同時,還需同時提供接口的說明文檔。但我們的代碼總是會根據實際情況來實時更新,這個時候有可能會忘記更新接口的說明文檔,造成一些不必要的問題。
用人話說,Swagger就是幫你寫接口說明文檔的。更具體地,可以看下面的圖片,swagger官方建議使用下面的紅字部分,這篇博客主要是記錄如何,使用swagger自動生成Api文檔的,所以只介紹swagger-ui,其他的…以后我用到會再整理。
swagger-ui
用來顯示API文檔的,不可編輯,會根據我們在代碼中的設置來自動生成Api說明文檔。生成的api文檔如下
API
版權聲明:本文內容由網絡用戶投稿,版權歸原作者所有,本站不擁有其著作權,亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容,請聯系我們jiasou666@gmail.com 處理,核實后本網站將在24小時內刪除侵權內容。
版權聲明:本文內容由網絡用戶投稿,版權歸原作者所有,本站不擁有其著作權,亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容,請聯系我們jiasou666@gmail.com 處理,核實后本網站將在24小時內刪除侵權內容。