SpringBoot实现Swagger接口响应信息自定义(一)

  swagger提供了一套完整的接口文档解决方案,只需在pom文件中加入swagger相关的包并简单配置一下即可得到一份完整的接口文档,想要更详细规范的信息还可在Controller类中加入类似@ApiOperation注解,诸如这些swagger的基本使用网上有很多教程,这里不在赘述。
  本篇主要讲述如何使用SpringBoot实现Swagger接口信息自定义。

场景

  接口相关信息如路径、参数等数据可能来自枚举、模板文档、数据库等。

初版解决方案:依据swagger工作原理,实现ApiListingScannerPlugin接口

  为了搞清楚各个参数的含义是什么,这里将关键的信息用1、2、3数字替代,对于其他的一些参数的含义,字面意思相信也能理解,实在不能理解可以自行阅读下源码

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Component;
import com.fasterxml.classmate.TypeResolver;
import com.google.common.collect.Sets;
import com.xxx.UserDTO;

import springfox.documentation.builders.OperationBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.
  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 5
    评论
评论 5
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值