b2b2c電子商務(wù)社交平臺(tái)源碼請(qǐng)加企鵝求求：一零三八七七四六二六。首先聲明下，apidoc是基于注釋來(lái)生成文檔的，它不基于任何框架，而且支持大多數(shù)編程語(yǔ)言，為了springboot系列的完整性，所以標(biāo)了個(gè)題。

一、apidoc簡(jiǎn)介

apidoc通過(guò)在你代碼的注釋來(lái)生成api文檔的。它對(duì)代碼沒(méi)有侵入性，只需要你寫(xiě)好相關(guān)的注釋即可，并且它僅通過(guò)寫(xiě)簡(jiǎn)單的配置就可以生成高顏值的api接口頁(yè)面。它基于node.js，所以你需要安裝node.js環(huán)境。node.js安裝。這里就不介紹。

二、準(zhǔn)備工作

安裝完node.js安裝api.doc

通過(guò)命令安裝：

npm install apidoc -g復(fù)制代碼

三、注釋怎么寫(xiě)

@api {method} path [title]method：請(qǐng)求方法， path：請(qǐng)求路徑 title(可選)：標(biāo)題 @apiDescription @apiDescription text text說(shuō)明 @apiError @apiError [(group)] [{type}] field [description]（group）（可選）：參數(shù)將以這個(gè)名稱(chēng)分組，不設(shè)置的話(huà)，默認(rèn)是Error 4xx {type}（可選）：返回值類(lèi)型，例如：{Boolean}, {Number}, {String}, {Object}, {String[]} field：返回值字段名稱(chēng) descriptionoptional（可選）：返回值字段說(shuō)明 @apiGroup @apiGroup name name：組名稱(chēng)，也是導(dǎo)航的標(biāo)題復(fù)制代碼

寫(xiě)個(gè)注釋:

/*** @api {POST} /register 注冊(cè)用戶(hù)* @apiGroup Users* @apiVersion 0.0.1* @apiDescription 用于注冊(cè)用戶(hù)* @apiParam {String} account 用戶(hù)賬戶(hù)名* @apiParam {String} password 密碼* @apiParam {String} mobile 手機(jī)號(hào)* @apiParam {int} vip = 0 是否注冊(cè)Vip身份 0 普通用戶(hù) 1 Vip用戶(hù)* @apiParam {String} [recommend] 邀請(qǐng)碼* @apiParamExample {json} 請(qǐng)求樣例：* ?account=sodlinken&password=11223344&mobile=13739554137&vip=0&recommend=* @apiSuccess (200) {String} msg 信息* @apiSuccess (200) {int} code 0 代表無(wú)錯(cuò)誤 1代表有錯(cuò)誤* @apiSuccessExample {json} 返回樣例:* {"code":"0","msg":"注冊(cè)成功"}*/復(fù)制代碼

用apidoc命令生成文檔界面

先cd到工程的外層目錄，并在外層目建個(gè)輸出文檔的目錄，我建的是docapi。

輸命令：

apidoc -i chapter4/ -o apidoc/-i 輸入目錄 -o 輸出目錄復(fù)制代碼

Spring Cloud大型企業(yè)分布式微服務(wù)云構(gòu)建的B2B2C電子商務(wù)平臺(tái)源碼請(qǐng)加企鵝求求：一零三八七七四六二六

轉(zhuǎn)載于:https://juejin.im/post/5cde71c751882525c104c766

總結(jié)

以上是生活随笔為你收集整理的（十二）java springcloud b2b2c多用户商城系统-springboot集成apidoc的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。