一個項目有一個好的API 文檔會減少很多溝通成本,很大的提供工作效率,介紹一個神奇 Swagger UI
使用node 快速搭建一個API文檔
-下載Swagger UI
git clone https://github.com/swagger-api/swagger-ui.git
-下載express
npm install express --save
npm install -g express-generator
express babyswagger
cd babyswagger && npm install
-將下載的swagger 中的dist 文件夾複製到 express 項目的public 目錄中
-啓動express 項目
npm start
-神奇界面如下
-編輯API 文檔
-使用 Swagger Edit 在線編輯點這裏
-編輯好之後可以下載下來,如圖
-將下載的swagger.json文件放到 express項目的public 中,然後重新啓動express即可
總結,之前項目中寫過類似的文檔功能,效果幾乎一樣,但是沒有swagger ui 產品化,所以一些經典的工具或者經典的框架都是在解決中我們實際編碼過程中遇到的問題,關鍵是要解決問題時做好,做細,說不定就做出一個讓大家認可的產品來呢。