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

代碼即文檔

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

有這樣一段代碼

/*** Building a RESTful Web Service* 來自spring的官方示例:https://spring.io/guides/gs/rest-service/*/ @RestController public class GreetingController {private static final String template = "Hello, %s!";private final AtomicLong counter = new AtomicLong();/*** Web Endpoint greeting* @param name who is this* @return*/@RequestMapping("/greeting")public Greeting greeting(@RequestParam(value="name", defaultValue="World") String name) {return new Greeting(counter.incrementAndGet(),String.format(template, name));} }

運行插件

gradle? 運行? task: Tasks/documentation/apiggs

maven 運行? compile

生成文檔

在編譯目錄下生成apiggs文件夾，并生成三個文件：

1. .json文件，可直接導入postman

1. .adoc文件，Asciidoc源文件

1. .html文件，源文件渲染結果，效果如下圖

本文來自云棲社區合作伙伴“開源中國”

本文作者：王練

原文鏈接

總結

以上是生活随笔為你收集整理的Apiggs —— 非侵入性的 RestDoc 文档生成工具的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。