HttpDoc零侵入的RESTful API文檔框架

HttpDoc?是一個(gè)基于Java標(biāo)準(zhǔn)doc注釋構(gòu)建的代碼零侵入的HTTP RESTful API在線閱覽文檔及測(cè)試界面框架。

JSON-Editor:?httpdoc-ui?TextArea:?httpdoc-ui-v1

功能特性

• 基礎(chǔ)功能無(wú)需為配合HttpDoc框架而多寫一句代碼，甚至連doc注釋都不必寫，即可擁有項(xiàng)目的API文檔和測(cè)試界面。

• 遵循?RFC 2616 HTTP/1.1?規(guī)范，適配主流后臺(tái)WEB框架。

• 拓展多個(gè) Java Doc 注釋標(biāo)簽，滿足不同的文檔閱覽及在線測(cè)試需求。

• 一鍵生成SDK，支持多個(gè)平臺(tái)，讓前后臺(tái)以及跨平臺(tái)對(duì)接變得更簡(jiǎn)單。

• WEB服務(wù)器無(wú)關(guān)，同時(shí)支持 Spring Boot 命令方式啟動(dòng)。

• 支持 Maven Gradle 或JAR包依賴。

環(huán)境依賴

JDK 1.7 +

集成步驟

Maven

1. 引入依賴

????
????
????????
????????????jitpack.io
????????????https://www.jitpack.io
????????
????

????
????????
????????
????????????com.github.core-lib.httpdoc
????????????httpdoc-spring-mvc
????????????v1.5.3
????????
????????
????????
????????
????????????com.sun
????????????tools
????????????1.8
????????????system
????????????${env.JAVA_HOME}/lib/tools.jar
????????
????????
????

1. 配置插件

????org.apache.maven.plugins
????maven-resources-plugin
????3.1.0
????
????????UTF-8
????
????
????????
????????????copy-src
????????????process-sources
????????????
????????????????copy-resources
????????????
????????????
????????????????${project.build.directory}/classes
????????????????
????????????????????
????????????????????????${basedir}/src/main/java
????????????????????
????????????????
????????????
????????
????

1. 配置參數(shù)

• SpringMVC

  
  ????
  ????????httpdoc
  ????????io.httpdoc.web.HttpdocServletSupport
  ????????
  ????????????httpdoc
  ????????????項(xiàng)目名稱
  ????????
  ????????
  ????????????version
  ????????????項(xiàng)目版本
  ????????
  ????????
  ????????????description
  ????????????
  ????????????????
  ????????????
  ????????
  ????????
  ????????????dateFormat
  ????????????yyyy-MM-dd?HH