百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程网 > 正文

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

yuyutoo 2024-10-12 01:50 2 浏览 0 评论

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

  • 需要给前端输出接口对接文档,但系统暂时没有,只能手写
  • 有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


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

相关推荐

野路子科技!2步教你把手机改造成一个FTP服务器,支持PC互传

哈喽,大家好,我是野路子科技,今天来给大家带来一个教程,希望大家喜欢。正如标题所言,就是教大家如何把售价改造成FTP服务器,而这个时候估计有朋友会问了,把手机改造成FTP服务器有什么用呢?现在有Q...

不得不看:别样于Server-U的群晖文件存储服务器的搭建与使用

我先前的作品中,有着关于Server-U的ftp文件存储服务器的搭建与访问的头条文章和西瓜视频,而且我们通过各种方式也给各位粉丝介绍了如何突破局域网实现真正意义上的公网访问机制技术。关于Server-...

Qt三种方式实现FTP上传功能_qt引入qftp库

FTP协议FTP的中文名称是“文件传输协议”,是FileTransferProtocol三个英文单词的缩写。FTP协议是TCP/IP协议组中的协议之一,其传输效率非常高,在网络上传输大的文件时,经...

Filezilla文件服务器搭建及客户端的使用

FileZilla是一个免费开源的FTP软件,分为客户端版本和服务器版本,具备所有的FTP软件功能。可控性、有条理的界面和管理多站点的简化方式使得Filezilla客户端版成为一个方便高效的FTP客户...

美能达柯美/震旦复印机FTP扫描怎么设置?

好多网友不知道怎么安装美能达/震旦复印机扫描,用得最多是SMB和FTP扫描,相对于SMB来说,FTP扫描安装步骤更为便捷,不容易出问题,不需要设置文件夹共享,所以小编推荐FTP来扫描以美能达机器为例详...

CCD(简易FTP服务器软件)_简单ftp服务器软件

CCD简易FTP服务器软件是一款很方便的FPT搭建工具,可以将我们的电脑快速变成一个FPT服务器。使用方法非常简单,只要运行软件就会自动生效,下载银行有该资源。该工具是不提供操作界面的,其他用户可以输...

Ubuntu系统搭建FTP服务器教程_ubuntu架设服务器

在Ubuntu系统上搭建FTP服务器是文件传输的一个非常实用方法,适合需要进行大量文件交换的场景。以下是一步步指导,帮助您在Ubuntu上成功搭建FTP服务器。1.安装vsftpd软件...

理光FTP扫描设置教程_理光ftp扫描设置方法

此教程主要用来解决WIN10系统下不能使用SMB文件夹扫描的问题,由于旧的SMB协议存在安全漏洞,所以微软在新的系统,WIN8/WIN10/SERVER201220162018里使用了新的SMB传...

纯小白如何利用wireshark学习网络技术

写在前面工欲善其事必先利其器!熟悉掌握一种神器对以后的工作必然是有帮助的,下面我将从简单的描述Wireshark的使用和自己思考去写,若有错误或不足还请批评指正。...

京东买13盘位32GB内存NAS:NAS系统安装设置教程

本内容来源于@什么值得买APP,观点仅代表作者本人|作者:yasden你没有看错,我在京东自营商城购买硬件,组装了一台13盘位,32GB内存的NAS,硬盘有13个盘位!CPU是AMD的5500!本文...

FileZilla搭建FTP服务器图解教程_filezilla server搭建ftp服务器

...

python教程之FTP相关操作_python ftps

ftplib类库常用相关操作importftplibftp=ftplib.FTP()ftp.set_debuglevel(2)#打开调试级别2,显示详细信息ftp.connect(“I...

xftp怎么用,xftp怎么用,具体使用方法

Xftp是一款界面化的ftp传输工具,用起来方便简单,这里为大家分享下Xftp怎么使用?希望能帮到有需要的朋友。IIS7服务器管理工具可以批量管理、定时上传下载、同步操作、数据备份、到期提醒、自动更新...

树莓派文件上传和下载,详细步骤设置FTP服务器

在本指南中,详细记录了如何在树莓Pi上设置FTP。设置FTP可以在网络上轻松地将文件传输到Pi上。FTP是文件传输协议的缩写,只是一种通过网络在两个设备之间传输文件的方法。还有一种额外的方法,你可以用...

win10电脑操作系统,怎么设置FTP?windows10系统设置FTP操作方法

打印,打印,扫描的日常操作是每一个办公工作人员的必需专业技能,要应用FTP作用扫描文件到电脑上,最先要必须一台可以接受文件的FTP服务器。许多软件都需要收费标准进行,但人们还可以应用Windows的系...

取消回复欢迎 发表评论: