Swagger与knife4j的使用

最新推荐文章于 2024-08-26 21:38:55 发布

JIE结弦

最新推荐文章于 2024-08-26 21:38:55 发布

阅读量537

点赞数

分类专栏： web开发文章标签： java spring boot

本文链接：https://blog.csdn.net/m0_62091368/article/details/124877166

版权

本文介绍了Swagger作为接口文档框架的主要作用，如方便前后端分离开发和减轻接口文档编写负担，并详细阐述了SpringBoot集成Swagger的步骤，包括引入依赖、配置类和自动装配加载。同时，文章还探讨了Swagger常用注解及其用法。接着，文章转向了knife4j，它是Swagger的增强解决方案，提供快速集成、在线调试和离线文档等功能，并给出了具体集成步骤和访问地址。

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

Swagger
- 是一个规范和完整的框架，用于生成文档、描述接口、测试

knife4j
- 基于Swagger生成Api文档的增强解决方案

Swagger

主要作用：

使得前后端分离开发更加方便，有利于团队协作
接口的文档在线自动生成，降低后端开发人员编写接口文档的负担
功能测试

SpringBoot集成Swagger

引入依赖

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
</dependency>
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
</dependency>

配置类

package com.项目.common.swagger;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


@Configuration
@EnableSwagger2
public class SwaggerConfiguration {

   @Bean
   public