广告
返回顶部
首页 > 资讯 > 后端开发 > Python >swagger如何返回map字段注释
  • 515
分享到

swagger如何返回map字段注释

2024-04-02 19:04:59 515人浏览 安东尼

Python 官方文档:入门教程 => 点击学习

摘要

1.效果图如下: 2.controller层代码: import java.util.HashMap; import java.util.Map; import org.s

1.效果图如下:

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 显示返回模型的注释

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);
}

效果

以上为个人经验,希望能给大家一个参考,也希望大家多多支持编程网。

--结束END--

本文标题: swagger如何返回map字段注释

本文链接: https://www.lsjlt.com/news/129716.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • swagger如何返回map字段注释
    1.效果图如下: 2.controller层代码: import java.util.HashMap; import java.util.Map; import org.s...
    99+
    2022-11-12
  • swagger怎么返回map字段注释
    这篇文章将为大家详细讲解有关swagger怎么返回map字段注释,小编觉得挺实用的,因此分享给大家做个参考,希望大家阅读完这篇文章后可以有所收获。1.效果图如下:2.controller层代码: import java....
    99+
    2023-06-20
  • mysql如何修改字段注释
    这篇文章主要介绍“mysql如何修改字段注释”,在日常操作中,相信很多人在mysql如何修改字段注释问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”mysql如何修改字段注释”...
    99+
    2022-10-19
  • navicat如何显示字段注释
    这篇文章主要介绍navicat如何显示字段注释,文中介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们一定要看完!在MySQL数据库中,字段或列的注释是用属性comment来添加。创建新表的脚本中,可在字...
    99+
    2022-10-18
  • mysql如何设置字段注释
    小编给大家分享一下mysql如何设置字段注释,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获,下面让我们一起去了解一下吧! 设置方法...
    99+
    2022-10-19
  • mysql如何增加字段及注释
    这篇“mysql如何增加字段及注释”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价值,希望大家阅读完这篇文章能有所收获,下面我们一起来看看这篇“mysql...
    99+
    2022-10-19
  • mysql如何给表字段添加注释
    在MySQL中,可以使用ALTER TABLE语句给表字段添加注释。具体操作如下: 打开MySQL命令行工具或者使用可视化工具连...
    99+
    2023-10-24
    mysql
  • oracle如何添加表字段及注释
    要在Oracle中添加表字段及注释,可以使用ALTER TABLE语句。以下是一些示例:1. 添加一个新的表字段:```ALTER ...
    99+
    2023-08-29
    oracle
  • springboot jpa之返回表中部分字段如何处理
    这篇文章主要介绍springboot jpa之返回表中部分字段如何处理,文中介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们一定要看完!springboot jpa返回表中部分字段使用springboot jpa操作数据库可以...
    99+
    2023-06-22
  • MySql中的longtext字段的返回问题如何解决
    这篇文章主要介绍了MySql中的longtext字段的返回问题如何解决的相关知识,内容详细易懂,操作简单快捷,具有一定借鉴价值,相信大家阅读完这篇MySql中的longtext字段的返回问题如何解决文章都会有所收获,下面我们一起来看看吧。M...
    99+
    2023-07-02
  • MyBatis动态SQL如何实现前端指定返回字段
    目录动态SQL实现前端指定返回字段问题描述解决方案MyBatis如何返回部分字段.xml文件中resultMap的type改为第二种很笨的方法动态SQL实现前端指定返回字段 问题描述...
    99+
    2022-11-13
  • 如何只返回实体类中的部分字段问题
    目录如何只返回实体类中的部分字段在实体类上添加注解以下为对注解所有取值的简介java动态添加实体类字段并返回给前端工具类调用前端接口调用测试总结如何只返回实体类中的部分字段 在实体类...
    99+
    2023-05-20
    返回实体类字段 返回实体类部分字段 实体类的部分字段
  • SpringBoot如何整合ES解析搜索返回字段问题
    这篇文章主要讲解了“SpringBoot如何整合ES解析搜索返回字段问题”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“SpringBoot如何整合ES解析搜索返回字段问题”吧!1. 数据构造...
    99+
    2023-07-06
  • java只返回实体类中的部分字段问题如何解决
    这篇文章主要介绍了只返回实体类中的部分字段问题如何解决,具有一定借鉴价值,需要的朋友可以参考下。下面就和我一起来看看吧。如何只返回实体类中的部分字段在实体类上添加注解@JsonInclude(JsonInclude.Include.NON_...
    99+
    2023-07-06
  • 如何解决SSM Mapper文件查询出返回数据查不到个别字段的问题
    这篇文章将为大家详细讲解有关如何解决SSM Mapper文件查询出返回数据查不到个别字段的问题,小编觉得挺实用的,因此分享给大家做个参考,希望大家阅读完这篇文章后可以有所收获。SSM Mapper查询出返回数据查不到个别字段原因开...
    99+
    2023-06-28
  • mysql数据库对应库对应表中的注释信息以及加字段如何查询
    本文主要给大家简单讲讲mysql数据库对应库对应表中的注释信息以及加字段如何查询,相关专业术语大家可以上网查查或者找一些相关书籍补充一下,这里就不涉猎了,我们就直奔主题吧,希望mysql数据库对应库对应表中...
    99+
    2022-10-18
  • 如何解决使用Hybris Commerce User API读取用户信息时电话字段没有返回问题
    小编给大家分享一下如何解决使用Hybris Commerce User API读取用户信息时电话字段没有返回问题,希望大家阅读完这篇文章之后都有所收获,下面让我们一起去探讨吧!在使用Hybris Commerce User API读取一个u...
    99+
    2023-06-04
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作