springfox 源码分析(十七) Swagger2接口文档示例接口api-docs

最新推荐文章于 2024-04-12 06:00:00 发布

萧明

最新推荐文章于 2024-04-12 06:00:00 发布

阅读量3.3k

点赞数

分类专栏： springfox 源码分析文章标签： springfox源码 springfox-swagger swagger

本文链接：https://blog.csdn.net/u010192145/article/details/102479541

版权

本文档分析了Springfox Swagger2的/v2/api-docs接口，讲解了如何根据分组名称获取Swagger资源详细信息。核心逻辑包括从文档缓存获取Documentation对象，转化为Swagger对象，最后以JSON响应输出，方便开发者查看和调试接口。

摘要由CSDN通过智能技术生成

前面已经获取得到了swagger的分组接口信息了,接下来就是根据分组名称获取每个分组的Swagger资源详细信息,在springfox中提供了/v2/api-docs接口来进行获取

来看接口的源码

@Controller
@ApiIgnore
public class Swagger2Controller {

  public static final String DEFAULT_URL = "/v2/api-docs";
  private static final Logger LOGGER = LoggerFactory.getLogger(Swagger2Controller.class);
  private static final String HAL_MEDIA_TYPE = "application/hal+json";

  private final String hostNameOverride;
  private final DocumentationCache documentationCache;
  private final ServiceModelToSwagger2Mapper mapper;
  private final JsonSerializer jsonSerializer;

  @Autowired
  public Swagger2Controller(
      Environment environment,
      DocumentationCache documentationCache,
      ServiceModelToSwagger2Mapper mapper,
      JsonSerializer jsonSerializer) {

    this.hostNameOverride =
        environment.getProperty(
            "springfox.documentation.swagger.v2.host",
            &