精华内容
下载资源
问答
  • smart-doc是同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具。 Smart-doc基于接口源代码分析来生成接口文档,并实现零注释入侵。 您只需在开发时编写Javadoc注释,智能文档即可帮助您生成Markdown或...
  • smart-doc-maven-plugin是smart-doc官方团队开发的maven插件。 这个插件可以从 smart-doc 1.7.9 获得。 使用 smart-doc-maven-plugin 可以更轻松地将 smart-doc 集成到您的项目中,并且集成更轻量级。 您不再需要在...
  • Only the above three simple configuration items can make smart-doc-maven-plugin work. In fact, only the outPath configuration item is necessary. Detailed configuration content: When you need to use ...
  • smart-doc-example-cn-源码

    2021-07-24 02:26:22
    Smart-doc Samples 本项目是Smart-doc官方开发时的各种代码场景测试示例,由于smart-doc并不需要在项目运行过程中生成文档,最多只是依赖于编译过程。 因此本项目可能并不能正常启动运行,也不可作为学习spring boot...
  • SpringBoot 集成 Smart-Doc

    千次阅读 2020-07-24 09:37:03
    一 什么是 Smart-Doc smart-doc 是一个 java restful api 文档生成工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到...

    一 什么是 Smart-Doc

           smart-doc 是一个 java restful api 文档生成工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释的写,smart-doc就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污染,那请拥抱 smart-doc 吧!

    二  Smart-Doc 功能特性

    • 零注解、零学习成本、只需要写标准java注释。
    • 基于源代码接口定义自动推导,强大的返回结构推导。
    • 支持Spring MVC,Spring Boot,Spring Boot Web Flux(controller书写方式)。
    • 支持Callable,Future,CompletableFuture等异步接口返回的推导。
    • 支持JavaBean上的JSR303参数校验规范。
    • 对json请求参数的接口能够自动生成模拟json参数。
    • 对一些常用字段定义能够生成有效的模拟值。
    • 支持生成json返回值示例。
    • 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。
    • 支持生成多种格式文档:Markdown、HTML5、Asciidoctor、Postman Collection。
    • 轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。
    • 开放文档数据,可自由实现接入文档管理系统。
    • 支持生成dubbo rpc文档。

    三 集成 Smart-Doc

    3.1 引入依赖

    <dependency>
        <groupId>com.github.shalousun</groupId>
        <artifactId>smart-doc</artifactId>
        <version>1.8.1</version>
        <scope>test</scope>
    </dependency>

    3.2 创建 User 类

    public class User {
        /**
         * 姓名
         */
        private String name;
    
        /**
         * 年龄
         */
        private String age;
    
        /**
         * 电话
         */
        private String mobile;
    }

    3.3 创建 UserController 类

    /**
     * 用户管理
     */
    @RestController
    @RequestMapping("/user")
    public class UserController {
        
        /**
         * 添加用户
         * @param user
         * @return
         */
        @PostMapping("/addUser")
        public User getUser(@RequestBody User user) {
            return new User();
        }
    }

    3.4 新建一个单元测试类生成 html5 文档

    import com.power.common.enums.HttpCodeEnum;
    import com.power.doc.builder.HtmlApiDocBuilder;
    import com.power.doc.constants.DocGlobalConstants;
    import com.power.doc.model.*;
    import org.junit.jupiter.api.Test;
    import org.springframework.boot.test.context.SpringBootTest;
    
    import java.util.ArrayList;
    import java.util.List;
    
    @SpringBootTest
    public class ApiDocTests {
        
        @Test
        public void testBuilderControllersApi() {
            ApiConfig config = new ApiConfig();
            config.setServerUrl("http://localhost:8080");
            //当把AllInOne设置为true时,Smart-doc将会把所有接口生成到一个Markdown、HHTML或者AsciiDoc中
            config.setAllInOne(true);
    
            //HTML5文档,建议直接放到src/main/resources/static/doc下,Smart-doc提供一个配置常量HTML_DOC_OUT_PATH
            config.setOutPath(DocGlobalConstants.HTML_DOC_OUT_PATH);
    
            // 设置接口包扫描路径过滤,如果不配置则Smart-doc默认扫描所有的接口类
            // 配置多个报名有英文逗号隔开
            config.setPackageFilters("com.example.springbootsmartdoc.controller");
    
            //设置错误错列表,遍历自己的错误码设置给Smart-doc即可
            List<ApiErrorCode> errorCodeList = new ArrayList<>();
            for (HttpCodeEnum codeEnum : HttpCodeEnum.values()) {
                ApiErrorCode errorCode = new ApiErrorCode();
                errorCode.setValue(codeEnum.getCode()).setDesc(codeEnum.getMessage());
                errorCodeList.add(errorCode);
            }
    
            //不需要显示错误码,则可以不用设置错误码。
            config.setErrorCodes(errorCodeList);
            //生成Markdown文件
            HtmlApiDocBuilder.buildApiDoc(config);
        }
    }

    执行单元测试生成 html5 文档。

    3.5 查看文档

    启动 springboot 服务,访问 http://localhost:8080/doc/index.html 得到如下结果。

    4 参考文档

     https://gitee.com/sunyurepository/smart-doc/wikis/%E6%96%87%E6%A1%A3%E7%94%9F%E6%88%90?sort_id=1653105

    展开全文
  • smart-doc 使用说明

    2021-07-17 01:17:15
    文章目录smart-doc 使用说明特殊功能支持JSR303规范支持fastjson和Jackson字段注解如:请求参数忽略(1.5 + 版本)参数模拟文档变更记录字段版本记录多模块配置1. ApiConfig配置2. maven的classifier指定源码包文档...

    smart-doc 使用说明

    官方使用介绍:smart-doc功能使用介绍 - 上官胡闹的个人空间 - OSCHINA - 中文开源技术交流社区

    官方配置介绍:smart-doc-maven-plugin: smart-doc官方maven插件 (gitee.com)

    官方wiki:HOME - Wiki - Gitee.com

    对于smart-doc,官方是有3种方式的:

    • 单元测试生成(不推荐)
    • maven插件生成
    • gradle插件生成

    特殊功能

    支持JSR303规范

    支持fastjson和Jackson字段注解如:

    • @JSONField(serialize = false) – 字段忽略
    • @JSONField(name = “create_time”) – 字段名称

    请求参数忽略(1.5 + 版本)

    /**
         *  创建时间
         *  @ignore
         */
    private Timestamp createTime;
    

    参数模拟

    它会自动生成一个模拟参数,不用任何配置

    文档变更记录

    需要在smart-doc.json里增加配置:“allInOne”: true

    {
      "outPath": "D://md2",
      "allInOne": true
    }
    
    

    我们也可以自己设置它的一个变更记录,增加这个配置

     "revisionLogs": [{ //设置文档变更记录,没有需求可以不设置
          "version": "1.0", //文档版本号
          "revisionTime": "2020-12-31 10:30", //文档修订时间
          "status": "update", //变更操作状态,一般为:创建、更新等
          "author": "author", //文档变更作者
          "remarks": "desc" //变更描述
      }],
    

    而这个配置,不需要配置"allInOne": true

    字段版本记录

    使用原生注释:@since

     /**
         * @since 1.0
         * 用户名称
         */
        private String subUserName;
    
    

    多模块配置

    smart-doc之前说过是无侵入,通过注释来生成的API文档,所以对于多模块服务,无法获取到注释,需要获取到源代码才能进行分析,而对于这种情况,smart-doc也有手段解决。

    1. ApiConfig配置

    ApiConfig config = new ApiConfig();
    //以前的版本为setSourcePaths,SourceCodePath为SourcePath
    config.setSourceCodePaths(
            SourceCodePath.path().setDesc("本项目代码").setPath("src/main/java"),
            //smart-doc对路径自动会做处理,无论是window合适linux系统路径,直接拷贝贴入即可
            SourceCodePath.path().setDesc("加载外部项目源码").setPath("E:\\Test\\Mybatis-PageHelper-master\\src\\main\\java")
    );
    

    根据官网所说,后续版本不需要再手动配置,而这个功能我还没测试,其最终效果不得而见。

    2. maven的classifier指定源码包

    <!--依赖的库-->
    <dependency>
        <groupId>com.github.shalousun</groupId>
        <artifactId>common-util</artifactId>
        <version>[最新版本]</version>
    </dependency>
    <!--依赖库源码-->
    <dependency>
        <groupId>com.github.shalousun</groupId>
        <artifactId>common-util</artifactId>
        <version>[最新版本]</version>
        <classifier>sources</classifier>
        <!--设置为test,项目发布时source不会放入最终的产品包-->
        <scope>test</scope>
    </dependency>
    

    而这种方式在打包需要增加一个插件,才能在打包上将源码包打包的仓库

    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-source-plugin</artifactId>
        <version>3.1.0</version>
        <executions>
            <execution>
                <phase>package</phase>
                <goals>
                    <goal>jar-no-fork</goal>
                </goals>
            </execution>
        </executions>
    </plugin>
    

    文档输出

    默认我们是配置smart-doc.json的一个配置文件,里面必填参数就是“outPath”,

    {
      "outPath": "这里可以写resources下面的路径,在SpringBoot启动后就可以进行访问",
      "allInOne": true
    }
    

    路径配置好像不支持相对路径,所以使用绝对路径,但还有一个方法,就是使用代码:

    注意这里的postman和HTML只能输出一个

     @org.junit.Test
        public void smartDocApiConfig() {
            ApiConfig config = new ApiConfig();
            //导出postman建议将server设置成这样,然后在postman中建立一个server环境变量,调试时只需根据实际服务器来修改server的值。
            config.setServerUrl("http://{{server}}");
    
            config.setAllInOne(true);
            // 文档输出路径
            config.setOutPath(System.getProperty("user.dir") + DocGlobalConstants.FILE_SEPARATOR + DocGlobalConstants.HTML_DOC_OUT_PATH);
            // postman JSON输出(1.8+)
    //        PostmanJsonBuilder.buildPostmanCollection(config);
            // html 文档输出
            HtmlApiDocBuilder.buildApiDoc(config);
        }
    

    服务配置

    spring.resources.add-mappings=false只要配置了这个,就不能访问静态资源了,但如果是对于单体服务,这个配置不能改,所以,可能需要委婉一点处理。

    smart-doc自定义注释

    ignore注释,上面有提到过

    tag名称 描述
    @ignore ignore tag用于过滤请求参数对象上的某个字段,设置后smart-doc不输出改字段到请求参数列表中。
    @required 如果你没有使用JSR303参数验证规范实现的方式来标准字段,就可以使用@required去标注请求参数对象的字段,标注smart-doc在输出参数列表时会设置为true。

    配置请求参数和详情体包装

     "responseBodyAdvice":{ //自smart-doc 1.9.8起,ResponseBodyAdvice统一返回设置,可用ignoreResponseBodyAdvice tag来忽略
           "className":"com.power.common.model.CommonResult" //通用响应体
      },
      "requestBodyAdvice":{ //自smart-doc 2.1.4 起,支持设置RequestBodyAdvice统一请求包装类
           "className":"com.power.common.model.CommonResult"
      },
    

    smart-doc api如何做接口测试

    做测试,smart虽然没有提供,但是,它提供了与其他工具的对接,这点还是不错的,毕竟专业的还是专业的。

    1. 导入postman

    导入postman需要一个JSON文件,在smart-doc 1.7+ 是支持的。

    那么我们在去看看官方的配置说明:

    需要使用java代码来构建json:

     @org.junit.Test
        public void smartDocApiConfig() {
            ApiConfig config = new ApiConfig();
            //导出postman建议将server设置成这样,然后在postman中建立一个server环境变量,调试时只需根据实际服务器来修改server的值。
            config.setServerUrl("http://{{server}}");
    
            config.setAllInOne(true);
            // 文档输出路径
            config.setOutPath(System.getProperty("user.dir") + DocGlobalConstants.FILE_SEPARATOR + DocGlobalConstants.HTML_DOC_OUT_PATH);
            // postman JSON输出(1.8+)
            PostmanJsonBuilder.buildPostmanCollection(config);
            // html 文档输出
    //        HtmlApiDocBuilder.buildApiDoc(config);
        }
    

    将生成的JSON文件导入postman,进行测试。

    1. 在smart-doc里我们配置了http://{{server}},这个server是作为postman中的环境变量

    2. 在postman中,点击右上角配置,或是在左上角的new都可以新建环境变量

      image-20210523142954993

    3. 到这基本已经可以了,如果要做到自动化测试,还需要配各种变量和脚本,但根据现在的情况已经够用了。需要详细的可以到网上查看相关配置和语法。

    2.对接torna

    torna属于开源项目,需要下载部署

    部署

    部署方式可以是jar部署,和docker部署,详细的步骤在:torna使用步骤

    对于现在的项目完全使用jar包方式的没问题,毕竟都要下载。

    1. 导入数据库,复制官方的mysql.sql

      mysql -u root -p

      source ./mysql.sql

    2. 修改application.properties,mysql的连接

    3. 运行startup.sh

    登录

    1. torna超级管理员登录

      admin@torna.cn/123456
      

      image-20210523151450918

      API文档支持swagger和postman

      image-20210523151544429

      image-20210523151637751

      对接

      最后重点的一步来了,创建key

      对接需要3个key:

      • AppKey和secret

        空间列表,选择一个空间

      image-20210523151859970

      image-20210523151921563

      • AppToken

      这个需要进入项目,然后创建一个模块,然后找到openApi

      image-20210523153125889

    smart-doc对接

    只需要配置一些配置就行

    {
      "outPath": "D://md2",
    //  "allInOne": true,
    
      "serverUrl": "http://{{server}}",
      "revisionLogs": [{ //设置文档变更记录,没有需求可以不设置
        "version": "1.0", //文档版本号
        "revisionTime": "2020-12-31 10:30", //文档修订时间
        "status": "update", //变更操作状态,一般为:创建、更新等
        "author": "author", //文档变更作者
        "remarks": "desc" //变更描述
      }],
      "isStrict": false, //是否开启严格模式
    //  "packageFilters": "",//controller包过滤,多个包用英文逗号隔开
      "projectName": "smart-doc",//配置自己的项目名称
      "appKey": "20210523846044457521381376",// torna平台对接appKey,, @since 2.0.9
      "appToken": "a3f747cf83b94eb7927abd1e578fc87c", //torna平台appToken,@since 2.0.9
      "secret": "TDZQFAb*n7aAwY,M6#V68PO3BcobQTGY",//torna平台secret,@since 2.0.9
      "openUrl": "http://localhost:7700/api",//torna平台地址,填写自己的私有化部署地址@since 2.0.9
      "debugEnvName":"test", //torna测试环境
      "debugEnvUrl":"http://127.0.0.1"//torna
    }
    
    

    image-20210523154549367

    展开全文
  • 智能文档演示 介绍 智能文档教程,了解如何使用智能文档创建REST API文档。 ... smart-doc-API文档创建工具 建立API文件 mvn package 生成并运行项目 mvn package 该应用程序将从开始运行。 参考
  • Smart-doc学习

    2020-11-18 17:38:21
    1.Smart-doc概念: 一个 java restful api 文档生成工具,不用像Swagger一样写大量注解,完全基于接口源码分析来生成接口文档,但是需要按照 java的标准注释写 2.简单使用 2.1导入依赖 <!--导入Smart-doc依赖--&...

    1.Smart-doc概念:

    一个 java restful api 文档生成工具不用像Swagger一样写大量注解,完全基于接口源码分析来生成接口文档,但是需要按照 java的标准注释写

    2.简单使用

    2.1导入依赖

    <!--导入Smart-doc依赖-->
            <dependency>
                <groupId>com.github.shalousun</groupId>
                <artifactId>smart-doc</artifactId>
                <version>1.8.1</version>
                <scope>test</scope>
            </dependency>
    

    2.2测试代码

     @Test
        public void testBuilderControllersApi() {
            ApiConfig config = new ApiConfig();
            config.setServerUrl("http://localhost:8080");
            //当把AllInOne设置为true时,Smart-doc将会把所有接口生成到一个Markdown、HHTML或者AsciiDoc中
            config.setAllInOne(true);
    
            //HTML5文档,建议直接放到src/main/resources/static/doc下,Smart-doc提供一个配置常量HTML_DOC_OUT_PATH
            //源码---String HTML_DOC_OUT_PATH = "src/main/resources/static/doc";
            config.setOutPath(DocGlobalConstants.HTML_DOC_OUT_PATH);
    
            // 设置接口包扫描路径过滤,如果不配置则Smart-doc默认扫描所有的接口类
            // 配置多个报名有英文逗号隔开
            config.setPackageFilters("com.zx.swagger_3.Controller");
    
            //设置错误错列表,遍历自己的错误码设置给Smart-doc即可
            List<ApiErrorCode> errorCodeList = new ArrayList<>();
            for (HttpCodeEnum codeEnum : HttpCodeEnum.values()) {
                ApiErrorCode errorCode = new ApiErrorCode();
                errorCode.setValue(codeEnum.getCode()).setDesc(codeEnum.getMessage());
                errorCodeList.add(errorCode);
            }
    
            //不需要显示错误码,则可以不用设置错误码。
            config.setErrorCodes(errorCodeList);
            //生成Markdown文件
            HtmlApiDocBuilder.buildApiDoc(config);
        }
    

    运行后会在对应目录生成htmlAPI接口文档

    2.3检查控制层和实体类上的注释

    /**
     * 用户控制类
     */
    @Api(value="用户controller",tags={"用户操作接口"})
    @RestController
    public class UserController {
    
        /**
         * 获取用户数据
         * @return
         */
        @GetMapping("/getUser")
        public User getUser() {
            return new User("zhangxi","123");
        }
    
        /**
         * 添加用户信息
         * @param user
         * @return
         */
        @PostMapping("/setUser")
        public User setUser(User user)
        {
            return user;
        }
    }
    
    @ApiModel("User用户实体类")
    public class User {
        /**
         * 用户名
         */
        @ApiModelProperty("用户名")
        private String username;
    
        /**
         * 密码
         */
        @ApiModelProperty("密码")
        private String password;
    

    2.4通过项目路径访问该html静态资源

    在这里插入图片描述
    参考博客1
    博客2

    展开全文
  • Spring Boot集成smart-doc生成api文档

    千次阅读 热门讨论 2019-10-01 21:13:59
    mart-doc是一个java restful api文档生成工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java...

    作为开发,写接口文档一直是一个很头痛的问题,尤其在前后端分离大量盛行的当下,后端必须要为前端同事提供明确的入参出参文档,否则整个对接工作无法顺利进行,前后端的相爱相杀的大戏时常上演。笔者刚工作的那些年,swagger都还没有正式发布,对接前端和app端的文档全靠手写markdown完成。写接口文档的时间常常感jio比写代码耗费的时间还长。随着技术的进步和众多开源人的努力,近几年针对java开发的文档生成工具越来越多。新入行的开发人员再也不用去体会过去的那些辛酸历程。在java文档生成的这个领域,swagger一直是一只领头羊。可能占据着90%的市场, 除此还有像 Spring REST Doc这些有名的工具也被大量的使用,但是这些工具在笔者看来使用比较蛮烦,侵入性高。今天笔者要给大家介绍和推荐一款本人开源的文档工具smart-doc,也会介绍如何使用这个工具来生成自己的文档。

    一、当前市面上文档工具存在的问题

    下面来列举当前市场上主流文档工具的问题:

    • 侵入性强,需要编写大量注解,代表工具如:swagger,还有一些公司自研的文档工具
    • 强依赖性,如果项目不想使用该工具,业务代码无法编译通过。
    • 代码解析能力弱,使用文档不齐全,主要代表为国内众多开源的相关工具。
    • 众多基于注释分析的工具无法解析jar包里面的注释(sources jar包),需要人工配置源码路径,无法满足DevOps构建场景。
    • 无法支持多模块复杂项目代码分析。

    二、smart-doc如何解决上述问题

    • 通过分析源码注释自动生成API文档,不用编写任何注解,秉承注释即文档的原则,并且提供注释强制检查。
    • smart-doc开发了smart-doc-maven-plugin和smart-doc-gradle-plugin插件,项目仅仅依赖插件,剔除插件无修改项目不报任何编译错误。
    • smart-doc在国内经过上百家企业的使用,做了很多场景的分析,解析能力很强。
    • smart-doc的maven和gradle插件自动分析项目依赖,自动完成对自发布jar包和第三方jar包源码的加载,不需要指定任何源码路径。
    • smart-doc的maven和gradle能够自动识别项目依赖,多模块maven和gradle项目都不是问题。
    • smart-doc文档维护比较完善,码云上的wiki有20个页面介绍各种使用方式。

    关于smart-doc

    三、smar-doc的不足

    smart-doc并非是完美的,仍然有很多不足。

    • 界面支持不完善,没有发送请求的页面,无法满足小团队自测。
    • 一些使用场景支持不完善,存在一些bug。
    • 暂不支持其他框架文档的生成,如:dubbo等。
    • 开源团队人员少,功能实现慢。

    四、spring boot集成smart-doc生成文档。

    上面说了关于一起其它工具的问题,也介绍了smart-doc的优缺点,下面进入正题,如何快速使用smart-doc生成文档。

    4.1 添加插件

    在spring boot项目pom中添加smart-doc的maven插件

     <plugin>
    	<groupId>com.github.shalousun</groupId>
    	<artifactId>smart-doc-maven-plugin</artifactId>
    	<version>[最新版本]</version>
    	<configuration>
    		<!--指定生成文档使用的配置文件-->
    		<configFile>./src/main/resources/smart-doc.json</configFile>
    	</configuration>
    	<executions>
    		<execution>
     			<!--不需要在编译项目时自动生成文档可注释phase-->
    			<phase>compile</phase>
    			<goals>
    				<goal>html</goal>
    			</goals>
    		</execution>
    	</executions>
    </plugin>
    
    
    

    4.2 添加smart-doc.json配置文件

    在4.1的代码片段中看到需要给插件指定一个生成文档的配置文件smart-doc.json。文件内容如下:

    {
      "serverUrl": "http://127.0.0.1",//服务器地址
      "isStrict": false,//是否用严格模式,严格模式强制检查注释
      "allInOne": true,//所有接口文档合并生成到一个文档
      "outPath": "src/main/resources/static/doc",//文档的输出路径
      "projectName": "smart-doc"//指定项目名称,用于显示在文档中
    }
    
    
    

    上面的几行配置中,实际上只有outPath是必须要的,其他都是非必须。相比其它工具,smart-doc配置简单又不会影响到项目。想了解更多详细配置请参考smart-doc插件使用

    4.3 编写controller接口

    @RestController
    @RequestMapping("/user")
    public class UserController {
    
        /**
         * 添加用户
         * @param user
         * @return
         */
        @PostMapping("/add")
        public User addUser(@RequestBody User user){
            return user;
        }
    }
    
    
    

    实体类:

    public class User {
    
        /**
         * 用户名
         */
        private String userName;
    
        /**
         * 昵称
         */
        private String nickName;
    
        /**
         * 用户地址
         */
        private String userAddress;
    
        /**
         * 用户年龄
         */
        private int userAge;
    
        /**
         * 手机号
         */
        private String phone;
    
        /**
         * 创建时间
         */
        private Long createTime;
    
        /**
         * ipv6
         */
        private String ipv6;
    
        /**
         * 固定电话
         */
        private String telephone;
        //省略get set
    }
    
    
    

    4.4 运行插件生成文档

    idea中smart-doc-maven插件使用

    效果见4.5

    4.5 用户信息操作接口

    添加用户

    URL:http://localhost:8080/user/add

    Type:POST

    Content-Type:application/json; charset=utf-8

    Request-parameters:

    Parameter Type Description Required Since
    userName string 用户名 false -
    nickName string 昵称 false -
    userAddress string 用户地址 false -
    userAge int 用户年龄 false -
    phone string 手机号 false -
    createTime number 创建时间 false -
    ipv6 string ipv6 false -
    telephone string 固定电话 false -

    Request-example:

    {
        "userName":"鹏飞.贺",
        "nickName":"raymond.gutkowski",
        "userAddress":"Apt. 819 萧旁7699号, 章丘, 滇 852063",
        "userAge":41,
        "phone":"15018373016",
        "createTime":1569934393095,
        "ipv6":"9eb3:fada:ffd2:912e:6225:1062:a2d7:718f",
        "telephone":"15018373016"
    }
    
    
    

    Response-fields:

    Field Type Description Since
    userName string 用户名 -
    nickName string 昵称 -
    userAddress string 用户地址 -
    userAge int 用户年龄 -
    phone string 手机号 -
    createTime number 创建时间 -
    ipv6 string ipv6 -
    telephone string 固定电话 -

    Response-example:

    {
        "userName":"鹏飞.贺",
        "nickName":"raymond.gutkowski",
        "userAddress":"Apt. 819 萧旁7699号, 章丘, 滇 852063",
        "userAge":41,
        "phone":"15018373016",
        "createTime":1569934393095,
        "ipv6":"9eb3:fada:ffd2:912e:6225:1062:a2d7:718f",
        "telephone":"15018373016"
    }
    
    
    

    总结

    当前最新的smart-doc结合插件后,已经做到了非常易于使用,只需要引入插件和根据自己需求填充相关的配置即可,非常的轻量级。将smart-doc推荐给大家是为了帮助更多的同行能够快速的生成api文档,也是给一些正在自研的同行提供一些实现思路。想要参与贡献,帮助smart-doc不断完善的开发者,我们也非常欢迎加入。如果您喜欢smart-doc,请记得为我们项目点赞,您的支持是我们一直开源的动力!!!

    展开全文
  • 1、smart-doc介绍 smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型定义推导的理念, 完全基于接口源码来分析生成接口文档,不采用任何注解侵入到...
  • https://github.com/smart-doc-group/smart-doc/blob/master/README_CN.md smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型定义推导的理念, ...
  • smart-doc接口文档

    2021-07-31 15:10:33
    依赖: <!--生成文档注释--> <dependency>...smart-doc</artifactId> <version>1.8.1</version> <scope>test</scope> </dependency> 测试类:
  • springboot集成smartDoc导出接口文档到tornasmart-docpom.xml添加依赖创建smart-doc.json创建导出文档文件夹导出接口文档到html smart-doc ...pom.xml添加依赖 ...smart-doc-maven-plugin</artifactId>
  • 工具开源地址 ...smart-doc:...swagger2 和 smart-doc 两个开源工具 都可以 使用jar包 生成 api 文档。 相同点: 这个两个工具 都可以 自动 扫描 有 @Controller 注解的 类 并生成 相应的...
  • smart-doc是一个java restful api文档生成工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java...
  • 用GitHub项目smart-doc生成接口文档

    千次阅读 2019-11-19 11:09:28
    利用smart-doc生成一个接口文档,关于它的优点什么的就不多说了。 项目地址:https://github.com/shalousun/smart-doc 具体使用 maven引用 <dependency> <groupId>com.github.shalousun</...
  • smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,还支持接口在线调试。 不用依赖任何注解,不会像swagger一样需要写很多繁琐的注解 ...smart-doc-maven-plugin</artifactId..
  • 官方说明:smart-doc是一个java restful api文档生成工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只...
  • smart-doc介绍 - 创建md、html等格式的接口文档 showdoc-在线API文档、技术文档工具 - 保存、预览接口文档,开源,可以自己部署服务 - 支持手动创建 和 上传。 二、smart-doc 使用注意事项、总结 基础使用,看官方...
  • Tips:喜欢的话可以关注小萌哦~~~ ...smart-doc 是一个 java restful api 文档生成工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口...
  • Smart-doc教程 一、基础入门: 首先第一个要推荐的绝对是官方wiki文档,因为smart-doc的更新速度很快,网上的教程或者介绍大多是2.0版本之前的,而且因为比较新这个工具,所以资源也比较少,因此以下的学习分享...
  • 本项目通过springboot+smart-doc+torna 实现接口文档的自动创建与文档推送 开发环境 JDK 1.8 + Maven 3.5 + IntelliJ IDEA ULTIMATE 2018.2 + (注意:务必使用 IDEA 开发,同时保证安装 lombok 插件) PostgreSql...
  • springboot集成smart-doc

    2021-06-25 14:31:54
    参考:...依赖 <dependency> <groupId>.../groupId>...smart-doc</artifactId> <version>1.8.1</version> <scope>test<
  • 如何利用smart-doc生成接口文档?想必很多在使用springboot项目的小伙伴的朋友们都知道swagger是个硬伤 但是真的没办法的 真的 我推荐使用的是smart-doc文档 真的很方便 也很好的使用! 说多了都是装逼 那么我们来...
  • smart-doc通过对javadoc注释的源码就行分析,生成html接口文档,然后将文档推送到torna统一展示。故对于代码规范要求很严格。 1.JavaDoc规范。添加类、方法注解 标签 描述 示例 @author 标识一个类的...
  • 介绍了在使用smart-doc做api文档的一些心得体会

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 11,230
精华内容 4,492
关键字:

smart-doc