springboot集成apidoc的步驟

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

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

一、apidoc簡介

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

二、準(zhǔn)備工作

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

通過命令安裝：

npm install apidoc -g

三、注釋怎么寫

• @api

@api {method} path [title]

method：請求方法，
path：請求路徑 
title(可選)：標(biāo)題

• @apiDescription

@apiDescription text
text說明

• @apiError

@apiError [(group)] [{type}] field [description]

（group）（可選）：參數(shù)將以這個名稱分組，不設(shè)置的話，默認(rèn)是Error 4xx 
{type}（可選）：返回值類型，例如：{Boolean}, {Number}, {String}, {Object}, {String[]} 
field：返回值字段名稱 
descriptionoptional（可選）：返回值字段說明

• @apiGroup

@apiGroup name
name：組名稱，也是導(dǎo)航的標(biāo)題

更多注釋，參見官方文檔：http://apidocjs.com/#params

四、寫給栗子

首先寫配置文件

在項目的主目錄新建一個apidoc.json文件：

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

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

寫個注釋:

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

用apidoc命令生成文檔界面

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

輸命令：

apidoc -i chapter4/ -o apidoc/

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

chapter4是我的工程名。

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

打開index.html,可以看到文檔頁面:

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

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

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

廣告

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