最近在将多个服务端项目的接口进行整合管理，原本使用的是Swagger接口文档管理插件，网上搜了一下类似的插件，发现这个smart-doc插件，似乎挺简约优雅的，而且还可以推送接口文档到Torna，进行统一管理，这功能相当不错。

一、引入smart-doc接口文档管理插件

1、引入插件

pom.xml

<!-- 引入 smart-doc 插件 -->
<plugin>
    <groupId>com.github.shalousun</groupId>
    <artifactId>smart-doc-maven-plugin</artifactId>
    <version>2.2.7</version>
    <configuration>
        <!-- 指定生成文档使用的配置文件 -->
        <configFile>./src/main/resources/smart-doc.json</configFile>
        <projectName>欢迎使用 Smart-Doc~</projectName>
    </configuration>
</plugin>
<!-- / 引入 smart-doc 插件 -->

2、新建接口文档配置文件

smart-doc.json

{
  "serverUrl": "http://127.0.0.1:8091",
  "isStrict": false,
  "allInOne": true,
  "createDebugPage": true,
  "style":"xt256",
  "allInOneDocFileName":"index.html",
  "outPath": "src/main/resources/static/doc",
  "packageFilters": "org.example.controller.*",
  "projectName": "欢迎使用 smart-doc ~"
}

3、新建静态资源配置文件

StaticResourceConfig.java

@Configuration
public class StaticResourceConfig extends WebMvcConfigurationSupport {

    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");

        /* 配置 smart-doc 资源路径 */
        registry.addResourceHandler("/doc/**").addResourceLocations("classpath:/static/doc/");
        /* / 配置 smart-doc 资源路径 */
    }
}

4、APP配置文件

application.yml

server:
  port: 8091

spring:
  application:
    name: "帅龍之龍"

logging:
  level:
    org.example.scheduled: DEBUG
  file:
    name: log/app.log
  charset:
    console: utf-8

二、统一接口返回

1、新建统一接口返回类文件

Result.java

package org.example.pojo.response;

public class Result <T> {

    /**
     * 响应状态
     * @since 1.0.0
     */
    private boolean success = true;

    /**
     * 错误码
     * @since 1.0.0
     */
    private int errno = 0;

    /**
     * 响应消息
     * @since 1.0.0
     */
    private String msg;

    /**
     * 响应数据
     * @since 1.0.0
     */
    private T data;

    public Result(boolean success, String msg) {
        this.success = success;
        this.msg = msg;
    }

    public Result(boolean success, String msg, T data) {
        this.success = success;
        this.msg = msg;
        this.data = data;
    }

    public Result(boolean success, int errno, String msg) {
        this.success = success;
        this.errno = errno;
        this.msg = msg;
    }

    public Result(boolean success, int errno, String msg, T data) {
        this.success = success;
        this.errno = errno;
        this.msg = msg;
        this.data = data;
    }

    public boolean getSuccess() {
        return success;
    }

    public void setSuccess(boolean success) {
        this.success = success;
    }

    public int getErrno() {
        return errno;
    }

    public void setErrno(int errno) {
        this.errno = errno;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }

    @Override
    public String toString() {
        return "Result{" +
                "success=" + success +
                ", msg='" + msg + '\'' +
                ", data=" + data +
                '}';
    }
}

2、新建用户视图类

UserDto.java

import lombok.Data;
import java.util.Date;

@Data
public class UserDto {

    /**
     * 用户ID
     */
    private Long id;

    /**
     * 用户名
     */
    private String username;

    /**
     * 用户密码
     */
    private String password;

    /**
     * 用户地址
     */
    private String address;

    /**
     * 用户年龄
     */
    private int userAge;

    /**
     * 手机号
     */
    private String phone;

    /**
     * 创建时间
     */
    private Date createTime;
}

3、新建用户信息管理控制器

UserManageController.java

/**
 * 用户管理模块
 */
@RestController
@RequestMapping(value = "api")
public class UserManageController {

    /**
     * 根据用户ID查询用户信息
     * @author 帅龍之龍
     * @param userId 用户ID 示例:5201314
     * @return
     */
    @GetMapping(value = "getUserById")
    public Result getUserById(@RequestParam(value = "userId", defaultValue = "10001") Long userId) {
        UserDto userDto = new UserDto();
        userDto.setId(userId);
        userDto.setUsername("帅龍之龍");
        userDto.setPassword("123456");
        userDto.setUserAge(25);
        userDto.setPhone("134****3051");
        userDto.setCreateTime(new Date());
        userDto.setAddress("地球村");
        return new Result(true, "getUserById 成功", userDto);
    }
}

三、参考
https://blog.csdn.net/shalousun/article/details/101865769
https://blog.csdn.net/pastxu/article/details/124531612

四、效果