代码拉取完成，页面将自动刷新
JSON-Editor: httpdoc-ui TextArea: httpdoc-ui-v1
JDK 1.7 +
<project>
<!-- 设置 jitpack.io 仓库 -->
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
<dependencies>
<!-- 添加 HttpDoc 依赖 -->
<dependency>
<groupId>com.github.core-lib.httpdoc</groupId>
<artifactId>httpdoc-spring-mvc</artifactId>
<version>v1.8.1</version>
</dependency>
<!-- 添加JDK的tools.jar依赖用于解析源码注释，采用这种方式部署到Tomcat时需要往Tomcat的lib目录增加该tools.jar -->
<dependency>
<groupId>com.sun</groupId>
<artifactId>tools</artifactId>
<version>1.8</version>
<scope>system</scope>
<systemPath>${env.JAVA_HOME}/lib/tools.jar</systemPath>
</dependency>
<!-- 当然还有很多种方式来依赖tools.jar，例如上传到自己的私服或从别的仓库中依赖进来 -->
</dependencies>
</project>
<!-- 由于框架基于源码注释解析来实现，所以保留源码是基础，如果只想要在线测试而没有文档阅览的需求，可不必添加该插件。-->
<!-- 如果项目是多模块项目，需要被解析的源码类分散在多模块中，则其他模块也需要配置该插件，或在父项目的pom.xml中配置该插件。-->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>3.1.0</version>
<configuration>
<encoding>UTF-8</encoding>
</configuration>
<executions>
<execution>
<id>copy-src</id>
<phase>process-sources</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>${project.build.directory}/classes</outputDirectory>
<resources>
<resource>
<directory>${basedir}/src/main/java</directory>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
SpringMVC
<web-app>
<servlet>
<servlet-name>httpdoc</servlet-name>
<servlet-class>io.httpdoc.web.HttpdocServletSupport</servlet-class>
<init-param>
<param-name>packages</param-name>
<param-value>io.httpdoc.sample</param-value>
</init-param>
<init-param>
<param-name>httpdoc</param-name>
<param-value>项目名称</param-value>
</init-param>
<init-param>
<param-name>version</param-name>
<param-value>项目版本</param-value>
</init-param>
<init-param>
<param-name>description</param-name>
<param-value>
<![CDATA[
项目描述(可以内嵌HTML标签)
]]>
</param-value>
</init-param>
<init-param>
<param-name>dateFormat</param-name>
<param-value>yyyy-MM-dd HH:mm:ss</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>httpdoc</servlet-name>
<url-pattern>/httpdoc.json</url-pattern>
</servlet-mapping>
</web-app>
<mvc:resources mapping="/httpdoc-ui/**" location="classpath:/META-INF/resources/httpdoc-ui/"/>
Spring Boot
<dependency>
<groupId>com.github.core-lib.httpdoc</groupId>
<artifactId>httpdoc-spring-boot</artifactId>
<version>v1.8.1</version>
</dependency>
@SpringBootApplication
@EnableHttpdoc(
packages = {"io.httpdoc.sample"},
httpdoc = "服务名称",
version = "服务版本",
description = "服务描述-支持HTML语法。"
)
public class HttpdocApplication {
public static void main(String[] args) {
SpringApplication.run(HttpdocApplication.class, args);
}
}
| 参数名称 | 参数说明 | 缺省值 |
|---|---|---|
| packages | 源码包名 | 必填参数，支持配置多个，通过英文逗号，空格及换行符拆分，支持递归搜索 |
| httpdoc | 项目名称 | HttpDoc |
| version | 项目版本 | 1.0.0 |
| description | 项目描述 | 可以用套起来并使用HTML标签语法 |
| protocol | 访问协议 | http或https，缺省为request.getProtocol(); |
| hostname | 主机名 | request.getServerName(); |
| port | 端口号 | request.getServerPort(); |
| context | 容器路径 | request.getContextPath(); |
| dateFormat | 日期格式 | yyyy-MM-dd HH:mm:ss |
| translator | 文档翻译器 | 自动匹配当前项目的WEB框架 |
| interpreter | 文档解释器 | 源码解释器 |
| serializer | 文档序列化器 | JSON序列化器，所以项目中需要依赖jackson-databind |
项目中的httpdoc-sample模块就是一个HttpDoc + SpringMVC的一个标准示例，可checkout后查看源码和编译运行查看效果，也可立即预览：JSON-Editor: httpdoc-ui TextArea: httpdoc-ui-v1
QQ 646742615 不会钓鱼的兔子
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。