Swagger2 生成API文档时泛型总是显示不出来的问题

## 接口响应消息体

/***      Copyright (c) 2018-2025, lengleng All rights reserved.**  Redistribution and use in source and binary forms, with or without*  modification, are permitted provided that the following conditions are met:** Redistributions of source code must retain the above copyright notice,*  this list of conditions and the following disclaimer.*  Redistributions in binary form must reproduce the above copyright*  notice, this list of conditions and the following disclaimer in the*  documentation and/or other materials provided with the distribution.*  Neither the name of the hzcloud.com developer nor the names of its*  contributors may be used to endorse or promote products derived from*  this software without specific prior written permission.*  Author: lengleng (wangiegie@gmail.com)**/package com.hzcloud.hz.common.core.util;import com.hzcloud.hz.common.core.constant.CommonConstants;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.*;
import lombok.experimental.Accessors;import java.io.Serializable;/*** 响应信息主体** @param <T>* @author lengleng*/
@ToString
@NoArgsConstructor
@AllArgsConstructor
@Accessors(chain = true)
@ApiModel(value = "响应信息主体")
public class R<T> implements Serializable {private static final long serialVersionUID = 1L;@Getter@Setter@ApiModelProperty(value = "返回标记：成功标记=0，失败标记=1")private int code;@Getter@Setter@ApiModelProperty(value = "返回信息")private String msg;@Getter@Setter@ApiModelProperty(value = "数据")private T data;public static <T> R<T> ok() {return restResult(null, CommonConstants.SUCCESS, null);}public static <T> R<T> ok(T data) {return restResult(data, CommonConstants.SUCCESS, null);}public static <T> R<T> ok(T data, String msg) {return restResult(data, CommonConstants.SUCCESS, msg);}public static <T> R<T> failed() {return restResult(null, CommonConstants.FAIL, null);}public static <T> R<T> failed(String msg) {return restResult(null, CommonConstants.FAIL, msg);}public static <T> R<T> failed(T data) {return restResult(data, CommonConstants.FAIL, null);}public static <T> R<T> failed(T data, String msg) {return restResult(data, CommonConstants.FAIL, msg);}private static <T> R<T> restResult(T data, int code, String msg) {R<T> apiResult = new R<>();apiResult.setCode(code);apiResult.setData(data);apiResult.setMsg(msg);return apiResult;}
}

## 使用：在接口返回值后加上类的名称

#如下返回值为 R 这个Integer就是类型名称

/*** 查询未完成的场次的数量* @return 未完成的场次的数量*/@GetMapping("/queryUnfinishedImplementationCount")@ApiOperation(value = "查询未完成的场次的数量", notes = "查询未完成的场次的数量")public R<Integer> getById() {QueryWrapper<FlightplanSet> flightplanSetQueryWrapper=new QueryWrapper<>();flightplanSetQueryWrapper.eq("implementation_status",Constants.FLIGHT_PLAN_SET_IMPLEMENTATION_STATUS_OF_UNFINISHED);flightplanSetQueryWrapper.eq("del_flag",Constants.DEL_FLAG_NORMAL);return R.ok(flightplanSetService.count(flightplanSetQueryWrapper));}

结果，swagger就会生成带有返回结构的响应体

Swagger2 生成API文档时泛型总是显示不出来的问题相关推荐

SpringBoot2.x整合Swagger2 实现API文档实时生成
我们提供Restful接口的时候,API文档是尤为的重要,它承载着对接口的定义,描述等,本文主要介绍了SpringBoot集成Swagger2生成接口文档的方法示例,需要的朋友们下面随着小编来一起学习 ...
为TypeScript项目生成API文档
为TypeScript项目生成文档使用typedoc为TypeScript项目生成API文档. 1. 使用typedoc生成HTML文档需要安装 typedoc. npm i typedoc 可以 ...
干掉 Postman？测试接口直接生成API文档，这工具真香！
前几天粉丝群有小伙伴问,有啥好用的API文档工具推荐,无意间发现了一款工具,这里马不停蹄的来给大家分享一下. ShowDoc一个非常适合团队的在线API文档工具,也支持用docker自建文档服务,不过 ...
干掉 Postman？测试接口直接生成API文档，这个工具我爱了
前几天粉丝群有小伙伴问,有啥好用的API文档工具推荐,无意间发现了一款工具,这里马不停蹄的来给大家分享一下. ShowDoc一个非常适合团队的在线API文档工具,也支持用docker自建文档服务,不过 ...
springboot 集成 swagger 自动生成API文档
Swagger是一个规范和完整的框架,用于生成.描述.调用和可视化RESTful风格的Web服务.简单来说,Swagger是一个功能强大的接口管理工具,并且提供了多种编程语言的前后端分离解决方案. S ...
knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案
knife4j knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望它能像一把匕首一样小巧,轻量, ...
【接口文档】Django restful framework中自动生成API文档
Django restful framework中自动生成API文档一.Swagger概述 1.引言当接口开发完成,紧接着需要编写接口文档.传统的接口文档使用Word编写,or一些接口文档管理平台 ...
浅析如何在Nancy中使用Swagger生成API文档
原文:浅析如何在Nancy中使用Swagger生成API文档前言上一篇博客介绍了使用Nancy框架内部的方法来创建了一个简单到不能再简单的Document.但是还有许许多多的不足. 为了能稍微完善 ...
干掉 Swagger + Postman？测试接口直接生成API文档，这个国产文档工具真香！
点击上方"芋道源码",选择"设为星标" 管她前浪,还是后浪? 能浪的浪,才是好浪! 每天 10:33 更新文章,每天掉亿点点头发... 源码精品专栏原创 | ...

Swagger2 生成API文档时泛型总是显示不出来的问题

## 接口响应消息体

## 使用：在接口返回值后加上类的名称

结果，swagger就会生成带有返回结构的响应体

Swagger2 生成API文档时泛型总是显示不出来的问题相关推荐

最新文章

热门文章