3.編寫api
4.執行命令,生成文件
目前前後端分離的模式,已經深得各大公司的喜愛,然而前後端溝通的成本就增加了,我們的書面文件就成了關鍵,想想,我們在開發的時候,直接把文件丟給相應的呼叫介面的人,不管是前端後端,都開心了.按照介面文件的規範去開發,效率會提高很多.
apidoc官網
二.介面文件
乙個規範的介面包含以下內容
三.apidoc生成文件
1. 全域性安裝
$ npm install apidoc -g2.1 方式二
可以在package.json最後麵加,這樣相比上面的方式就不用再加乙個檔案了
"apidoc"
:
/**
* @api http://localhost:3000/register 使用者註冊
* @apidescription 使用者註冊
* @apiname submit-login
* @apigroup user
* @apiparam (body) email 使用者郵箱
* @apiparam (body) password 使用者密碼
* * @apisuccess code 錯誤狀態碼.
* @apisuccess msg 錯誤訊息.
;
4.執行命令,生成文件
命令:
$ apidoc -i .
/-o .
/public
/apidoc
"scripts"
:
-o 輸出目錄名。放置生成的文件的位置。
通過本地網域名稱去訪問:http://localhost:3000/docs/index.html即可
swagger2 生成介面文件步驟
匯入jar包 swagger2 io.springfox groupid springfox swagger2 artifactid dependency 防止進入swagger頁面報型別轉換錯誤，排除2.9 2中的引用，手動增加1.5 21版本 io.swagger groupid swagger...
匯出swagger2生成的文件
沒錯這個專案就是專門根據json解析生成文件的。二 修改配置 解壓專案，並且用idea開啟。啟動要生成文件的專案，前提這個專案整合了swagger2，瀏覽 http localhost 8080 swagger ui.html 輸入 http localhost 8080 v2 api docs 儲...
百曉生 滑鼠右鍵新建新增RTF文件
百曉生 滑鼠右鍵新建新增rtf文件 今天想將空間日誌作個本地備份，但是苦於找不到適合的文字工具，因為一般的文字編輯工具都不支援貼圖。雖然word就可以滿足我們的需求，但檔案格式不用doc而是rtf 而我以前清理登錄檔時把所有的無用檔案都刪除了，所有現在需要重新加入rtf文件。我們既可以享用word提...