Java非侵入式API接口文檔工具apigcc用法詳解

更新時間：2020年07月06日 09:15:57 作者：BarryW

這篇文章主要介紹了Java非侵入式API接口文檔工具apigcc用法詳解,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下

一個非侵入的api編譯、收集、Rest文檔生成工具。工具通過分析代碼和注釋，獲取文檔信息，生成RestDoc文檔

前言

程序員一直以來都有一個煩惱，只想寫代碼，不想寫文檔。代碼就表達了我的思想和靈魂。

Python提出了一個方案，叫docstring，來試圖解決這個問題。即編寫代碼，同時也能寫出文檔，保持代碼和文檔的一致。docstring說白了就是一堆代碼中的注釋。Python的docstring可以通過help函數直接輸出一份有格式的文檔，本工具的思想與此類似。

代碼即文檔

Apigcc是一個非侵入的RestDoc文檔生成工具。工具通過分析代碼和注釋，獲取文檔信息，生成RestDoc文檔。

有這樣一段代碼

/**
 * 歡迎使用Apigcc
 * @index 1
 */
@RestController
public class HelloController {

  /**
   * 示例接口
   * @param name 名稱
   * @return
   */
  @RequestMapping("/greeting")
  public HelloDTO greeting(@RequestParam(defaultValue="apigcc") String name) {
    return new HelloDTO("hello "+name);
  }

}

使用方式

apiggs-maven-plugin

easy use apigcc with maven

安裝

<plugin>
  <groupId>com.github.apiggs</groupId>
  <artifactId>apiggs-maven-plugin</artifactId>
  <version><!-- 替換為上方版本號 --></version>
  <executions>
    <execution>
      <phase>compile</phase>
      <goals>
        <goal>apiggs</goal>
      </goals>
    </execution>
  </executions>
  <configuration>
    <!-- options in there -->
  </configuration>
</plugin>

when you compile source code, apiggs will build rest doc.

options

id 項目id，生成id.html文件
title 文檔標題
description 文檔描述
production 輸出文件夾，默認為 apiggs
out 輸出目錄，默認為 target
source 源碼目錄
dependency 源碼依賴的代碼目錄，以逗號隔開
jar 源碼依賴的jar包目錄，以逗號隔開
ignore 忽略某些類型
version 文檔版本號

執(zhí)行方法：

查看API文檔：

另外，也可以放入容器遠程訪問，方法如下：

這里提供了一個已打好的jar

運行項目

gradlew build
cd service\build\libs
java -jar apigcc-hub-{version}.jar

瀏覽器訪問http://127.0.0.1:8080

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章:

SpringBoot通過自定義注解實現(xiàn)參數校驗
實現(xiàn)參數校驗說實話方式還挺多，個人使用過直接在Controller代碼里面寫、AOP+自定義注解、ConstraintValidator。本文主要和大家講的是ConstraintValidator實現(xiàn)，感興趣的可以了解一下
2022-12-12
spring Roo安裝使用簡介
這篇文章主要介紹了spring Roo安裝使用簡介，具有一定借鑒價值,需要的朋友可以參考下
2017-12-12
Java如何獲取當天零點和明天零點的時間和時間戳
這篇文章主要介紹了如何在Java中獲取當天零點和明天零點的時間和時間戳,并提供了示例代碼,新手小白完全可以通過文中介紹的代碼實現(xiàn),需要的朋友可以參考下
2025-03-03
Java網絡編程之簡易聊天室的實現(xiàn)
這篇文章主要為大家詳細介紹了如何利用Java語言實現(xiàn)一個簡易聊天室功能，可以實現(xiàn)運行客戶端和連接服務器，文中的示例代碼講解詳細，需要的可以了解一下
2022-10-10
Spring MVC中使用Google kaptcha驗證碼的方法詳解
kaptcha 是一個非常實用的驗證碼生成工具。有了它，你可以生成各種樣式的驗證碼，因為它是可配置的，下面這篇文章主要給大家介紹了關于Spring MVC中使用Google kaptcha驗證碼的方法，需要的朋友可以參考借鑒，下面來一起看看吧。
2017-10-10
Java根據日期截取字符串的多種實現(xiàn)方法
在實際開發(fā)中,我們經常會遇到需要根據日期來截取字符串的需求,例如從文件名中提取日期信息,Java 提供了多種方法來實現(xiàn)根據日期來截取字符串的功能,本文將給大家介紹了Java根據日期截取字符串的多種實現(xiàn)方法,需要的朋友可以參考下
2024-11-11
spring?security?自定義Provider?如何實現(xiàn)多種認證
這篇文章主要介紹了spring?security?自定義Provider實現(xiàn)多種認證方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
2021-12-12
Java截取字符串的方法
這篇文章主要介紹了Java截取字符串的方法,實例分析了java中substring方法的使用技巧,需要的朋友可以參考下
2015-05-05
http協(xié)議進階之Transfer-Encoding和HttpCore實現(xiàn)詳解
這篇文章主要給大家介紹了http協(xié)議之Transfer-Encoding和HttpCore實現(xiàn)的相關資料，文中介紹的非常詳細，相信對大家具有一定的參考價值，需要的朋友們下面來一起看看吧。
2017-04-04
解決mybatis plus報錯Invalid bound statement
在使用MyBatis時遇到InvalidBoundStatement異常,常因多個MapperScan配置沖突或者包掃描路徑設置錯誤,解決方法包括保留一個MapperScan聲明、檢查jar包沖突、確保命名空間和掃描路徑正確,使用@TableId注解指定主鍵
2024-11-11