HttpDoc零侵入的RESTful API文档框架

HttpDoc 是一个基于Java标准doc注释构建的代码零侵入的HTTP RESTful API在线阅览文档及测试界面框架。

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

功能特性

• 基础功能无需为配合HttpDoc框架而多写一句代码，甚至连doc注释都不必写，即可拥有项目的API文档和测试界面。

• 遵循 RFC 2616 HTTP/1.1 规范，适配主流后台WEB框架。

• 拓展多个 Java Doc 注释标签，满足不同的文档阅览及在线测试需求。

• 一键生成SDK，支持多个平台，让前后台以及跨平台对接变得更简单。

• WEB服务器无关，同时支持 Spring Boot 命令方式启动。

• 支持 Maven Gradle 或JAR包依赖。

环境依赖

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. 配置参数

• SpringMVC

  
      
          httpdoc
          io.httpdoc.web.HttpdocServletSupport
          
              httpdoc
              项目名称
          
          
              version
              项目版本
          
          
              description
              
                  
              
          
          
              dateFormat
              yyyy-MM-dd HH