資訊專欄INFORMATION COLUMN
摘要：首先聲明下，是基于注釋來生成文檔的，它不基于任何框架，而且支持大多數(shù)編程語言，為了系列的完整性，所以標了個題。二準備工作安裝完安裝它的項目源碼。輸命令輸入目錄輸出目錄是我的工程名。
首先聲明下，apidoc是基于注釋來生成文檔的，它不基于任何框架，而且支持大多數(shù)編程語言，為了springboot系列的完整性，所以標了個題。
一、apidoc簡介apidoc通過在你代碼的注釋來生成api文檔的。它對代碼沒有侵入性，只需要你寫好相關(guān)的注釋即可，并且它僅通過寫簡單的配置就可以生成高顏值的api接口頁面。它基于node.js，所以你需要安裝node.js環(huán)境。node.js安裝，點擊這里。這里就不介紹。
二、準備工作安裝完node.js安裝api.doc,它的項目源碼：https://github.com/apidoc/apidoc 。
通過命令安裝：
npm install apidoc -g三、注釋怎么寫
@api
@api {method} path [title]
method：請求方法，
path：請求路徑
title(可選)：標題
@apiDescription
@apiDescription text text說明
@apiError
@apiError [(group)] [{type}] field [description]
（group）（可選）：參數(shù)將以這個名稱分組，不設(shè)置的話，默認是Error 4xx
{type}（可選）：返回值類型，例如：{Boolean}, {Number}, {String}, {Object}, {String[]}
field：返回值字段名稱
descriptionoptional（可選）：返回值字段說明
@apiGroup
@apiGroup name name：組名稱，也是導(dǎo)航的標題
更多注釋，參見官方文檔：http://apidocjs.com/#params
四、寫給栗子首先寫配置文件
在項目的主目錄新建一個apidoc.json文件：
{
"name": "example",
"version": "0.1.0",
"description": "A basic apiDoc example"
}
更多配置參考：http://apidocjs.com/#configur...
寫個注釋:
/**
* @api {POST} /register 注冊用戶
* @apiGroup Users
* @apiVersion 0.0.1
* @apiDescription 用于注冊用戶
* @apiParam {String} account 用戶賬戶名
* @apiParam {String} password 密碼
* @apiParam {String} mobile 手機號
* @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,可以看到文檔頁面:
五、參考資料apidoc
apidocjs.com
使用apidoc 生成Restful web Api文檔
文章版權(quán)歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請注明本文地址：http://systransis.cn/yun/67816.html
這篇文章主要介紹如何在springboot中如何創(chuàng)建含有多個module的工程，栗子中含有兩個 module，一個作為libarary. 工程，另外一個是主工程，調(diào)用libary .其中l(wèi)ibary jar有一個服務(wù)，main工程調(diào)用這個服務(wù)。 創(chuàng)建根工程 創(chuàng)建一個maven 工程,其pom文件為： 4.0.0 com.forezp springboot-multi-...
摘要：用于控制活動人數(shù)，將超過此一定閥值的訂單直接丟棄。緩解短時間的高流量壓垮應(yīng)用。目前比較推薦的就是我們手動然后將消費錯誤的消息轉(zhuǎn)移到其它的消息隊列中，做補償處理消費者該方案是默認的方式不太推薦。 SpringBoot 是為了簡化 Spring 應(yīng)用的創(chuàng)建、運行、調(diào)試、部署等一系列問題而誕生的產(chǎn)物，自動裝配的特性讓我們可以更好的關(guān)注業(yè)務(wù)本身而不是外部的XML配置，我們只需遵循規(guī)范，引入相...
摘要：本文介紹如何在中使用默認的聲明式緩存定義和接口用來統(tǒng)一不同的緩存技術(shù)。在使用集成的時候，我們需要注冊實現(xiàn)的的。默認使用在我們不使用其他第三方緩存依賴的時候，自動采用作為緩存管理器。源碼下載參考資料揭秘與實戰(zhàn)二數(shù)據(jù)緩存篇快速入門 本文介紹如何在springboot中使用默認的spring cache 聲明式緩存 Spring 定義 CacheManager 和 Cache 接口用來統(tǒng)一不...
摘要：另外很容易構(gòu)建風格的，簡單優(yōu)雅帥氣，正如它的名字。配置一些基本的信息。三寫生產(chǎn)文檔的注解通過注解表明該接口會生成文檔，包括接口名請求方法參數(shù)返回信息的等等。四參考資料中使用構(gòu)建強大的文檔 swagger,中文拽的意思。它是一個功能強大的api框架，它的集成非常簡單，不僅提供了在線文檔的查閱，而且還提供了在線文檔的測試。另外swagger很容易構(gòu)建restful風格的api，簡單優(yōu)雅帥氣...
閱讀 3235·2021-11-08 13:21
閱讀 1213·2021-08-12 13:28
閱讀 1421·2019-08-30 14:23
閱讀 1941·2019-08-30 11:09
閱讀 853·2019-08-29 13:22
閱讀 2703·2019-08-29 13:12
閱讀 2564·2019-08-26 17:04
閱讀 2273·2019-08-26 13:22
