还在为Swagger添加一堆描述注解苦恼么?零注解方案推荐

不知各位程序猿在输出接口文档的时候，有这样苦恼的问题：

• 需要给前端输出接口对接文档，但系统暂时没有，只能手写
• 有swagger方式，但是每写一个接口，一堆的@ApiOperation、@ApiModelProperty(value = "Desc")等等，实际上也是在写文档
• 某些系统因为初期根本没有考虑，压根就不支持

那是否有懒人解决方案，不用动手，直接搞定的方案呢？

JApiDocs 能够解决上述问题，直接上图：

具体工程改造过程：

• 引入Maven依赖

<dependency>
            <groupId>io.github.yedaxia</groupId>
            <artifactId>japidocs</artifactId>
            <version>1.4.4</version>
</dependency>

• 添加初始化配置

import io.github.yedaxia.apidocs.Docs;
import io.github.yedaxia.apidocs.DocsConfig;
import org.springframework.context.annotation.Configuration;

import java.util.Locale;

/**
 * api 配置，用于接口文档生成
 *
 * @author : frank.nie@sina.com
 * @date : created in 2021/11/3 16:09
 */
@Configuration
public class ApiConfig {

    public ApiConfig() {
        DocsConfig cfg = new DocsConfig();
        // 实际代码工程所在路径
        cfg.setProjectPath("D:\\work\\workspace\\platform\\task-monitor");
        // api文档版本信息
        cfg.setApiVersion("V1.0");
        // 项目描述
        cfg.setProjectName("任务管理");
        // api文档生成目录
        cfg.setDocsPath("D:\\work\\workspace\\platform\\task-monitor\\apidocs");
        // 自动生成文档
        cfg.setAutoGenerate(Boolean.TRUE);
        cfg.setLocale(Locale.SIMPLIFIED_CHINESE);
         // docsConfig.addPlugin(new MarkdownDocPlugin());
        // 添加全局配置
        Docs.buildHtmlDocs(cfg);
    }

}

至此，完成系统改造！然后运行程序，即可生成api接口文档

本文实例Controller代码如下：

import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.io.Serializable;
import java.util.List;

/**
 * 接口文档样例
 *
 * @author : frank.nie@sina.com
 * @date : created in 2021/11/3 16:07
 */
@Slf4j
@RestController
@RequestMapping("/api/task/")
public class TaskController {

    @Data
    public static class TaskForm implements Serializable {

        /**
         * 任务id
         */
        String id;

        /**
         * 任务名称
         */
        String name;

        /**
         * 任务描述
         */
        String desc;
    }


    /**
     * 任务查询
     *
     * @return 查询的任务信息
     */
    @PostMapping("query")
    public ResponseEntity queryTask() {
        return ResponseEntity.ok("OK");
    }

    /**
     * 任务新增
     *
     * @param t 新增任务入参
     * @return ok-成功，failed-失败
     */
    @PostMapping("add")
    public ResponseEntity addTask(TaskForm t) {
        return ResponseEntity.ok("OK");
    }

    /**
     * 任务删除
     *
     * @param form 待删除的任务信息
     * @return ok-成功，failed-失败
     */
    @PostMapping("delete")
    public ResponseEntity deleteTask(List<TaskForm> form) {
        return ResponseEntity.ok("OK");
    }

    /**
     * 任务修改
     *
     * @param form 待更新的任务
     * @return ok-成功，failed-失败
     */
    @PostMapping("update")
    public ResponseEntity updateTask(TaskForm form) {
        return ResponseEntity.ok("OK");
    }
}

最终效果如下：

注意问题：

1. 暂时只支持 ≥ JDK1.8
2. 注意设置好工程的编码格式UTF-8

相关问题，欢迎留言提问；欢迎大家点赞、关注、收藏~