簡介
JApiDocs 是一個符合 Java 編程習慣的 Api 文檔生成工具。最大程度地利用 Java 的語法特性,你只管用心設計好接口,添加必要的注釋,JApiDocs 會幫你導出一份漂亮的 Html 文檔,並生成相關的 Java 和 Object-C 相關數據模型代碼,從此,Android 和 IOS 的同學可以少敲很多代碼了,你也不需要費力維護接口文檔的變化,只需要維護好你的代碼就可以了。
一個簡單的示例。
特性
-
以一個 Controller 作為一組接口導出到一個 Html 文件中。
-
支持生成 Java 和 Object-C 語言的 Response 模型代碼。
-
深度支持 Spring Boot, PlayFramework,JFinal,不需要額外聲明路由。
-
支持一般的 Java Web 工程,需要在相關方法添加額外的路由。
-
支持接口聲明過時(@Deprecated
),方便的文檔目錄等。
-
支持自定義代碼生成模板。