swagger使用

简单的进行使用Swagger后面在对这个工具的使用进行完善

1）第一步导入Swagger依赖

<!-- Swagger -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>

<!-- Swagger UI -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>

2）第二步需要编写一个配置类用来创建Docket文档对象

首先在config包中创建一个配置类主要写两个注解

@Configuration ：配置注解和@Bean联合使用用于创建类

@EnableSwagger2 ：用于开启Swagger2

package com.atguigu.paymentdemo.config;

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

/**
 * @auther fang
 * @date 2023/12/25 22:47
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {
    
    @Bean
    public Docket docket() { // 创建一个Docket文档类
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("微信支付案例接口文档") // 标题
                        .build());
    }
}

3）创建一个Controller测试类简单的进行测试一下

package com.atguigu.paymentdemo.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @auther fang
 * @date 2023/12/25 23:02
 */
@RestController
@RequestMapping("/api/product")
@Api(tags = "商品管理")
public class ProductController {

    @ApiOperation("测试接口")
    @GetMapping("/test")
    public String test() {
        return "hello";
    }

}

4）启动服务之后

输入网址：http://localhost:8090/swagger-ui.html

可以在这个网页上进行测试