Swagger2简介和配置_swagger 2.7怎么定义-优快云博客

本文链接：https://blog.youkuaiyun.com/ayuyux/article/details/108333711

本文介绍了Swagger2的基本概念及其在前后端分离开发中的重要性，详细讲解了如何配置Swagger2，包括引入依赖、创建配置类以及通过注解进行API模型的定义，如接口说明、参数说明等，以实现规范、及时且一致的接口文档，同时提供测试功能。

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

前后端分离开发模式中，api文档是最好的沟通方式。

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

及时性 (接口变更后，能够及时准确地通知相关前后端开发人员)
规范性 (并且保证接口的规范性，如接口的地址，请求方式，参数及响应格式和错误信息)
一致性 (接口信息一致，不会出现因开发人员拿到的文档版本不一致，而出现分歧)
可测性 (直接在接口文档上进行测试，以方便理解业务)

配置：

1、引入依赖

        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
            <scope>provided </scope>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
            <scope>provided </scope>
        </dependency>

2、创建配置类SwaggerConfig

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket webApiConfig(){

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()          
                .paths(PathSelectors.any())
                .build();

    }

    private ApiInfo webApiInfo(){

        return new ApiInfoBuilder()
                .title("网站-微服务API文档")
                .description("本文档描述了微服务接口定义")
                .version("1.0")
                .contact("Author")
                .build();
    }
}

3、在启动类上添加注解@ComponentScan，扫描配置类所在的包路径

@SpringBootApplication
@ComponentScan(basePackages = {"com.config"})
public class EduApplication {
    public static void main(String[] args) {
        SpringApplication.run(EduApplication.class, args);
    }
}

4.启动主类后，登录localhost:8001(自己的服务端口号)/swagger-ui.html ,查看效果

API模型

可以添加一些自定义设置，例如：

定义样例数据

@ApiModelProperty(value = "创建时间", example = "2020-01-01 8:00:00")
@TableField(fill = FieldFill.INSERT)
private Date gmtCreate;

@ApiModelProperty(value = "更新时间", example = "2020-01-01 8:00:00")
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date gmtModified;

定义接口说明和参数说明

定义在类上：@Api

定义在方法上：@ApiOperation

定义在参数上：@ApiParam

@Api(description="服务管理")
@RestController
@RequestMapping("/admin")
public class AdminController {

	@Autowired
	private AdmService admService;


	@ApiOperation(value = "根据ID删除数据")
	@DeleteMapping("{id}")
	public boolean removeById(
			@ApiParam(name = "id", value = "ID", required = true)
			@PathVariable String id){
		return admService.removeById(id);
	}
}