快捷導(dǎo)航

swagger如何返回map字段注釋

更新時(shí)間：2021年07月02日 17:08:56 作者：xingsfdz

這篇文章主要介紹了swagger如何返回map字段注釋的操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

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.用戶實(shí)體的代碼：

  
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;  
@ApiModel(value="登錄成功后返回的個(gè)人信息")
@Data
public class User {
	
	    @ApiModelProperty(value="用戶名")
	    private String userName;//用戶名
	    @ApiModelProperty(value="密碼")
	    private String password;//用戶名 
}

4.關(guān)鍵點(diǎn)：

接口 Swagger 顯示返回模型的注釋

mark：環(huán)境看之前文章

目的：web api controller 調(diào)用 asp.net mvc controller，讓swagger里面的返回模型支持注釋

關(guān)鍵：對(duì)返回消息類的封裝，返回?cái)?shù)據(jù)為泛型，swagger就能顯示model的注釋了

JsonMsg

/// <summary>
/// 返回消息
/// </summary>
public class JsonMsg<T> where T : class
{
    /// <summary>
    /// 狀態(tài)碼
    /// </summary>
    public int code { get; set; }
    /// <summary>
    /// 消息
    /// </summary>
    public string msg { get; set; }
    /// <summary>
    /// 內(nèi)容
    /// </summary>
    public T obj { get; set; }
    /// <summary>
    /// 圖標(biāo)
    /// </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);
}

效果