本篇內(nèi)容主要講解“springboot集成apidoc的步驟”，感興趣的朋友不妨來(lái)看看。本文介紹的方法操作簡(jiǎn)單快捷，實(shí)用性強(qiáng)。下面就讓小編來(lái)帶大家學(xué)習(xí)“springboot集成apidoc的步驟”吧!

公司主營(yíng)業(yè)務(wù)：網(wǎng)站制作、成都網(wǎng)站建設(shè)、移動(dòng)網(wǎng)站開(kāi)發(fā)等業(yè)務(wù)。幫助企業(yè)客戶(hù)真正實(shí)現(xiàn)互聯(lián)網(wǎng)宣傳，提高企業(yè)的競(jìng)爭(zhēng)能力。成都創(chuàng)新互聯(lián)公司是一支青春激揚(yáng)、勤奮敬業(yè)、活力青春激揚(yáng)、勤奮敬業(yè)、活力澎湃、和諧高效的團(tuán)隊(duì)。公司秉承以“開(kāi)放、自由、嚴(yán)謹(jǐn)、自律”為核心的企業(yè)文化，感謝他們對(duì)我們的高要求，感謝他們從不同領(lǐng)域給我們帶來(lái)的挑戰(zhàn)，讓我們激情的團(tuán)隊(duì)有機(jī)會(huì)用頭腦與智慧不斷的給客戶(hù)帶來(lái)驚喜。成都創(chuàng)新互聯(lián)公司推出龍井免費(fèi)做網(wǎng)站回饋大家。

一、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安裝，點(diǎn)擊這里。這里就不介紹。

二、準(zhǔn)備工作

安裝完node.js安裝api.doc,它的項(xiàng)目源碼：https://github.com/apidoc/apidoc 。

通過(guò)命令安裝：

npm install apidoc -g

三、注釋怎么寫(xiě)

• @api

@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è)置的話，默認(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)題

更多注釋?zhuān)瑓⒁?jiàn)官方文檔：http://apidocjs.com/#params

四、寫(xiě)給栗子

首先寫(xiě)配置文件

在項(xiàng)目的主目錄新建一個(gè)apidoc.json文件：

{
  "name": "example",
  "version": "0.1.0",
  "description": "A basic apiDoc example"
}

更多配置參考：http://apidocjs.com/#configuration

寫(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è)成功"}
     */

用apidoc命令生成文檔界面

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

輸命令：

apidoc -i chapter4/ -o apidoc/

-i 輸入目錄 -o 輸出目錄

chapter4是我的工程名。

可以看到在apidoc目錄生成了很多文件:

打開(kāi)index.html,可以看到文檔頁(yè)面:

到此，相信大家對(duì)“springboot集成apidoc的步驟”有了更深的了解，不妨來(lái)實(shí)際操作一番吧！這里是創(chuàng)新互聯(lián)網(wǎng)站，更多相關(guān)內(nèi)容可以進(jìn)入相關(guān)頻道進(jìn)行查詢(xún)，關(guān)注我們，繼續(xù)學(xué)習(xí)！

當(dāng)前題目：springboot集成apidoc的步驟
分享路徑：http://aaarwkj.com/article24/phdece.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供網(wǎng)站策劃、、標(biāo)簽優(yōu)化、搜索引擎優(yōu)化、App設(shè)計(jì)、網(wǎng)頁(yè)設(shè)計(jì)公司

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶(hù)投稿、用戶(hù)轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如需處理請(qǐng)聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來(lái)源： 創(chuàng)新互聯(lián)