springBoot 使用swagger2接口测试

本文详细介绍如何在SpringBoot项目中集成Swagger2进行接口测试,包括添加依赖、配置测试类及启动服务验证。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

springBoot 使用swagger2接口测试


springBoot 使用swagger2接口测试
pom.xml 文件中添加依赖

<!-- swagger依赖 -->
   	<dependency>
   		<groupId>io.springfox</groupId>
   		<artifactId>springfox-swagger2</artifactId>
   		<version>2.6.1</version>
   	</dependency>
   	<dependency>
   		<groupId>io.springfox</groupId>
   		<artifactId>springfox-swagger-ui</artifactId>
   		<version>2.6.1</version>
   	</dependency>

建立测试配置类,与springBoot启动类平级

package com.example.demo;

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 Swagger2 {
  //swagger2的配置文件,这里可以配置swagger2的一些基本的内容,比如扫描的包等等
  @Bean
  public Docket createRestApi() {
      return new Docket(DocumentationType.SWAGGER_2)
              .apiInfo(apiInfo())
              .select()
              //为当前包路径
              .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
              .paths(PathSelectors.any())
              .build();
  }
  //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
  private ApiInfo apiInfo() {
      return new ApiInfoBuilder()
              //页面标题
              .title("Spring Boot 测试使用 Swagger2 构建RESTful API")
              //创建人
              .contact(new Contact("范保林", "http://www.baidu.com", ""))
              //版本号
              .version("1.0")
              //描述
              .description("API 描述")
              .build();
  }

}

启动springBoot服务,输入[http://localhost:8080/swagger-ui.html]看到以下页面以及配置的controller层的接口就是成功

在这里插入图片描述
有时候swagger会出现这种问题:
在这里插入图片描述
我的解决方法:启动类上添加:@EnableSwagger2
在这里插入图片描述

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值