java中apidoc生成文檔,java api文檔生成

本文目錄一覽：

• 1、windows 下怎麼使用 apidoc 生成文檔
• 2、apidoc文檔使用方法
• 3、apidoct接口文檔參數提交格式問題
• 4、如何生成JavaAPI doc
• 5、apidoc怎麼使用？怎麼在myeclipse生成接口文檔？
• 6、如何優雅的“編寫”api接口文檔

windows 下怎麼使用 apidoc 生成文檔

1、安裝nodejs，nodejs里有npm，記得勾上

2、開始-運行-cmd， npm install apidoc

3、使用apidoc：

例如： node C:\Users\Administrator\node_modules\apidoc\bin\apidoc -i C:\xampp\htdocs\Application -o C:\xampp\htdocs\apidoc

ok。 實測能生成文檔。

apidoc文檔使用方法

0、本項目以laravel框架為例；

1、安裝： （安裝完成後所有位置都能執行相關命令）；

2、項目根目錄創建apidoc.json文件；

3、控制器中編寫對應的文檔信息；

4、根目錄執行命令生成文檔；

1、安裝根據官網教程即可；

2、項目根目錄創建對應的json文件；內容如下

3、控制器中編寫對應的文檔信息；(注釋部“/**/”分為文檔生成的內容)

4、根目錄執行命令生成文檔；

app/Http/Controllers/Admin —需要生成文檔的控制器地址

public/apidoc/admin —生成的文檔保存位置

apidoct接口文檔參數提交格式問題

方法一 每次請求: @apiHeader {string} Content-Type 請求數據格式

在接口文檔的注釋中加入,這樣在填寫表單時會多一個Content-Type

Content-Type 值填寫application/json

方法二 全局:找到apidoc模版send_sample_request.js

一般在C:\Users\電腦用戶名\AppData\Roaming\npm\node_modules\apidoc\template\utils

將ajax form表單的提交請求中加入三條

dataType: “json”,

contentType: “application/json”,

data: JSON.stringify(param),

如何生成JavaAPI doc

在代碼里用文檔注釋方法進行注釋

/**

* 注釋內容

*/

用cmd進去源代碼文件目錄

輸入指令javadoc -d MyAPIdoc xxx.java

敲回車就能在該目錄下生成文件了，這是比較簡單的一句話，當然還可以附加其他參數設置標題等。進生成目錄雙擊index.html就能看到自己的文檔了…

apidoc怎麼使用？怎麼在myeclipse生成接口文檔？

先按照平常軟件的安裝方法安裝,記住你的安裝目錄,下面說下破解;

破解步驟:

0:運行 run.bat

1. 輸入Usercode, 點擊’SystemId…’, 生成SystemId

2. 點擊’Active’, 生成LICENSE_KEY, ACTIVATION_CODE, ACTIVATION_KEY

3. 點擊菜單’Tools – 2.SaveProperties…’,

4. 點擊菜單’Tools – 1.ReplaceJarFile’, 選擇${eclipse_home}/plugins目錄, 等待30秒左右.

說明:${eclipse_home}/plugins是eclipse安裝目錄下有個pugins文件夾,,如果沒有,在common下的plugins下.

執行以上4個步驟,破解成功.

如何優雅的“編寫”api接口文檔

一些剛開始寫接口文檔的服務端同學，很容易按着代碼的思路去編寫接口文檔，這讓客戶端同學或者是服務對接方技術人員經常吐槽，看不懂接口文檔。這篇文章提供一個常規接口文檔的編寫方法，給大家參考。

推薦使用的是docway 寫接口文檔，方便保存和共享，支持導出PDF MARKDOWN，支持團隊項目管理。

一、請求參數

1. 請求方法

GET

用於獲取數據

POST

用於更新數據，可與PUT互換，語義上PUT支持冪等

PUT

用於新增數據，可與POST互換，語義上PUT支持冪等

DELETE

用於刪除數據

其他

其他的請求方法在一般的接口中很少使用。如：PATCH HEAD OPTIONS

2. URL

url表示了接口的請求路徑。路徑中可以包含參數，稱為地址參數，如**/user/{id}**，其中id作為一個參數。

3. HTTP Header

HTTP Header用於此次請求的基礎信息，在接口文檔中以K-V方式展示，其中Content-Type則是一個非常必要的header，它描述的請求體的數據類型。

常用的content-type：

application/x-www-form-urlencoded

請求參數使用“”符號連接。

application/json

內容為json格式

application/xml

內容為xml格式

multipart/form-data

內容為多個數據組成，有分隔符隔開

4. HTTP Body

描述http body，依賴於body中具體的數據類型。如果body中的數據是對象類型。則需要描述對象中字段的名稱、類型、長度、不能為空、默認值、說明。以表格的方式來表達最好。

示例：

二、響應參數

1. 響應 HTTP Body

響應body同請求body一樣，需要描述請清除數據的類型。

另外，如果服務會根據不同的http status code 返回不同的數據結構， 也需要針對不同的http status code對內容進行描述。

三、接口說明

說明接口的應用場景，特別的注意點，比如，接口是否冪等、處理是同步方式還是異步方式等。

四、示例

上個示例（重點都用紅筆圈出來，記牢了）：

五、接口工具

推薦使用的是（以前叫小幺雞） 寫接口文檔，方便保存和共享，支持導出PDF MARKDOWN，支持團隊項目管理。