1、介紹

JApiDocs 是一個符合 Java 編程習慣的 Api 文檔生成工具。最大程度地利用 Java 的語法特性，你只管用心設(shè)計好接口，添加必要的注釋，JApiDocs 會幫你導出一份漂亮的 Html 文檔，并生成相關(guān)的 Java 和 Object-C 相關(guān)數(shù)據(jù)模型代碼，從此，Android 和 IOS 的同學可以少敲很多代碼了，你也不需要費力維護接口文檔的變化，只需要維護好你的代碼就可以了。

實際使用中，你的原先代碼，可能如下：

/**

* Get User List

* @param listForm

*/

@RequestMapping(path = "list", method = {RequestMethod.GET, RequestMethod.POST} )

public ApiResult> list(UserListForm listForm){

return null;

}

此時，你的代碼不用改動 (僅僅需要引入依賴jar，和簡單的配置)，不用像swagger一樣額外通過注解的形式，來給該接口添加說明，該JApiDocs會自行給該接口添加接口說明和字段說明。

換言之，該 JApiDocs 會讀取源碼，并解析。

2、疑問

那么，問題來了，class字節(jié)碼是沒有注釋信息的，JApiDocs 又是怎么做到的？

3、解答

查閱readme，并 clone 出項目后，得到解釋如下：

接口對象在源碼中

我們知道，經(jīng)過編譯后的 class 字節(jié)碼中是沒有注釋信息的，如果要通過反射字節(jié)碼的方式來實現(xiàn)，則不可避免要引入運行時注解，這樣會增加使用成本， 考慮到這一點，JApiDocs 從第二個版本之后就改成了使用解析源碼的方式，而不是反射字節(jié)碼的思路來實現(xiàn)了，但這樣直接導致的缺陷就是： 所有的 Form Bean (表單)對象和返回對象就必須在項目的源碼中，否則就無法解析了，如果你們項目的JavaBean對象是通過jar包的形式提供的， 那很遺憾，JApiDocs將無法支持。

來源：oschina

鏈接：https://my.oschina.net/u/3136014/blog/4359967

總結(jié)

以上是生活随笔為你收集整理的japidocs怎么设置参数必填_JApiDocs 动态生成接口文档，并解析java 源码中的注释...的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

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