swagger如何返回map字段注释


Posted in Java/Android onJuly 03, 2021

1.效果图如下:

swagger如何返回map字段注释

2.controller层代码:

import java.util.HashMap;
import java.util.Map; 
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController; 
import com.mengyoou.core.serialize.ResponseMsg; 
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses; 
 
@Api(value="返回字段添加注释信息controller",tags={"返回字段添加注释信息controller"})
@RestController
public class TestController { 
	@ApiOperation(value="返回字段添加注释信息", notes="返回字段添加注释信息")
    @RequestMapping(value={"demo"}, method={RequestMethod.GET})
    @ApiResponses({
    	@ApiResponse(code = 200, message = "ok", response=User.class),
    })
    public ResponseMsg demo() {
    	User user = new User();
    	Map<String, Object> map = new HashMap<>();
    	map.put("user", user);
    	return new ResponseMsg(map);
    } 
}

3.用户实体的代码:

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;  
@ApiModel(value="登录成功后返回的个人信息")
@Data
public class User {
	
	    @ApiModelProperty(value="用户名")
	    private String userName;//用户名
	    @ApiModelProperty(value="密码")
	    private String password;//用户名 
}

4.关键点:

swagger如何返回map字段注释

接口 Swagger 显示返回模型的注释

mark:环境看之前文章

目的:web api controller 调用 asp.net mvc controller,让swagger里面的返回模型支持注释

关键:对返回消息类的封装,返回数据为泛型,swagger就能显示model的注释了

JsonMsg

/// <summary>
/// 返回消息
/// </summary>
public class JsonMsg<T> where T : class
{
    /// <summary>
    /// 状态码
    /// </summary>
    public int code { get; set; }
    /// <summary>
    /// 消息
    /// </summary>
    public string msg { get; set; }
    /// <summary>
    /// 内容
    /// </summary>
    public T obj { get; set; }
    /// <summary>
    /// 图标
    /// </summary>
    public int icon { get; set; }
    public static JsonMsg<T> OK(T obj, string msg = "成功") 
    {
        return new JsonMsg<T>() { code = 1, msg = msg, obj = obj, icon = 1 };
    }
    public static JsonMsg<T> Error(T obj, string msg = "失败")
    {
        return new JsonMsg<T>() { code = 0, msg = msg, obj = obj, icon = 1 };
    }
}

OrderDto

public class OrderDto
{
    public string Name { get; set; }
}

HomeController

public JsonResult GetOrderInfo()
{
    var order = new OrderDto { Name = "203022200" };
    return Json(order);
}

HomeAPIController

[AllowAnonymous]
public JsonMsg<OrderDto> testResultDataDesc3()
{
    HomeController controller = GetController<HomeController>();
    var d = (OrderDto)controller.GetOrderInfo().Data;
    return JsonMsg<OrderDto>.OK(d);
}

效果

swagger如何返回map字段注释

swagger如何返回map字段注释

swagger如何返回map字段注释

以上为个人经验,希望能给大家一个参考,也希望大家多多支持三水点靠木。

Java/Android 相关文章推荐
springboot @ConfigurationProperties和@PropertySource的区别
Jun 11 Java/Android
Java多条件判断场景中规则执行器的设计
Jun 26 Java/Android
详解Spring事件发布与监听机制
Jun 30 Java/Android
java调用Restful接口的三种方法
Aug 23 Java/Android
java多态注意项小结
Oct 16 Java/Android
MyBatis自定义SQL拦截器示例详解
Oct 24 Java/Android
Spring中的使用@Async异步调用方法
Nov 01 Java/Android
OpenCV实现普通阈值
Nov 17 Java/Android
Java9新特性对HTTP2协议支持与非阻塞HTTP API
Mar 16 Java/Android
Java 垃圾回收超详细讲解记忆集和卡表
Apr 08 Java/Android
Java实现添加条码或二维码到Word文档
Jun 01 Java/Android
app场景下uniapp的扫码记录
Jul 23 Java/Android
Springboot配置suffix指定mvc视图的后缀方法
java基础——多线程
JUnit5常用注解的使用
Jul 02 #Java/Android
解决Swagger2返回map复杂结构不能解析的问题
SpringBoot工程下使用OpenFeign的坑及解决
Jul 02 #Java/Android
SpringBoot读取Resource下文件的4种方法
Jul 02 #Java/Android
Java基础-封装和继承
You might like
php 网页游戏开发入门教程一(webgame+design)
2009/10/26 PHP
php 模拟POST提交的2种方法详解
2013/06/17 PHP
PHP fastcgi模式上传大文件(大约有300多K)报错
2014/09/28 PHP
JQuery Study Notes 学习笔记(一)
2010/08/04 Javascript
获取div编辑框,textarea,input text的光标位置 兼容IE,FF和Chrome的方法介绍
2012/11/08 Javascript
jquery的ajax请求全面了解
2013/03/20 Javascript
js实现简单的购物车有图有代码
2014/05/26 Javascript
一个奇葩的最短的 IE 版本判断JS脚本
2014/05/28 Javascript
JS实现可拖曳、可关闭的弹窗效果
2015/09/26 Javascript
使用jQuery判断Div是否在可视区域的方法 判断div是否可见
2016/02/17 Javascript
ES6概念 Symbol.keyFor()方法
2016/12/25 Javascript
详解升级react-router 4 踩坑指南
2017/08/14 Javascript
JS数组Object.keys()方法的使用示例
2019/06/05 Javascript
jquery.pager.js分页实现详解
2019/07/29 jQuery
更优雅的微信小程序骨架屏实现详解
2019/08/07 Javascript
Vue解析剪切板图片并实现发送功能
2020/02/04 Javascript
Vue全局使用less样式,组件使用全局样式文件中定义的变量操作
2020/10/21 Javascript
对numpy中数组元素的统一赋值实例
2018/04/04 Python
详解python环境安装selenium和手动下载安装selenium的方法
2020/03/17 Python
Django-migrate报错问题解决方案
2020/04/21 Python
全球最大最受欢迎的旅游社区:Tripadvisor
2017/11/03 全球购物
澳大利亚婴儿、幼儿和儿童在线设计师商店:Smooch Baby
2019/02/16 全球购物
英国独特家具和家庭用品购物网站:Cuckooland
2020/08/30 全球购物
实习生自我鉴定
2013/12/12 职场文书
人事部主管岗位职责
2013/12/26 职场文书
毕业生写求职信的要点
2014/03/04 职场文书
面试必备的求职信
2014/05/25 职场文书
个人授权委托书样本
2014/09/13 职场文书
专升本学生毕业自我鉴定
2014/10/04 职场文书
英文导游词
2015/02/13 职场文书
2015年建党94周年演讲稿
2015/03/19 职场文书
农村婚礼司仪主持词
2015/06/29 职场文书
《金钱的魔力》教学反思
2016/02/20 职场文书
2016基督教会圣诞节开幕词
2016/03/04 职场文书
2016年第十四个公民道德宣传日活动总
2016/04/01 职场文书
mybatis源码解读之executor包语句处理功能
2022/02/15 Java/Android