BugFactoryBuilder 2023-07-11 23:13 采纳率: 100%
浏览 54
已结题

关于#java#的问题:我有两个接口出参共用了一个 VO,我能不能通过配置 Swagger 使在线的接口文档出参只显示接口需要的字段呢

Swagger 在线文档配置问题

我有两个接口出参共用了一个 VO,我能不能通过配置 Swagger 使在线的接口文档出参只显示接口需要的字段呢。

  • 下面是个大致的例子,hidden 属性设置了好像对所有的接口都屏蔽了。
    // 接口
    @ApiOperation(value = "接口1", notes = "接口1")
    @GetMapping(value = "/getThis1")
    public Result<List<IdNameTransVo>> getThis(@RequestParam(name = "pageNo", defaultValue = "1") Integer pageNo,
                                                @RequestParam(name = "pageSize", defaultValue = "10") Integer pageSize) {
        List<IdNameTransBo> list = new ArrayList<>();
        return Result.OK(list);
    }

    @ApiOperation(value = "接口2", notes = "接口1")
    @GetMapping(value = "/getThis2")
    public Result<List<IdNameTransVo>> getThis(@RequestParam(name = "pageNo", defaultValue = "1") Integer pageNo,
                                                @RequestParam(name = "pageSize", defaultValue = "10") Integer pageSize) {
        List<IdNameTransBo> list = new ArrayList<>();
        return Result.OK(list);
    }
    // vo
  @Data
  @ApiModel(value ="IdNameTransVo")
  public class IdNameTransVo {
    /**
     * NAME
     */
    @ApiModelProperty(value = "name")
    private String name;
    /**
     * ID
     */
    @ApiModelProperty(value ="id")
    private String id;
    /**
     * field1 仅接口 1 使用
     */
    @ApiModelProperty(value ="field1")
    private int field1;
    /**
     * field2 仅接口 2 使用
     */
    @ApiModelProperty(value ="field1")
    private int field2;
}
  • 写回答

1条回答 默认 最新

  • chenxianchong 2023-07-12 10:30
    关注

    不可以

    本回答被题主选为最佳回答 , 对您是否有帮助呢?
    评论

报告相同问题?

问题事件

  • 已结题 (查看结题原因) 8月10日
  • 已采纳回答 8月10日
  • 修改了问题 7月11日
  • 创建了问题 7月11日