Swagger3的基本使用

「已注销」

已于 2022-07-12 23:40:54 修改

阅读量571

点赞数 1

于 2022-07-09 16:15:37 首次发布

本文链接：https://blog.csdn.net/Sinlair/article/details/125694916

版权

本文介绍了如何在Java项目中使用Swagger3进行API文档的生成和管理。首先，需要添加相关依赖；接着，在启动类上添加@EnableOpenApi注解启用Swagger3；然后，通过常见注释来描述API接口；最后，配置Swagger3的相关设置。完成这些步骤后，可以在http://localhost:8080/swagger-ui.html查看生成的文档。

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

1 添加依赖

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-boot-starter</artifactId>
  <version>3.0.0</version>
</dependency>

2 在启动类上添加注释

@EnableOpenApi

@EnableOpenApi
@SpringBootApplication
@MapperScan("net.www.mapper")
@EnableTransactionManagement
public class OnlineXdclassApplication {
	public static void main(String[] args) {
		SpringApplication.run(OnlineXdclassApplication.class, args);
	}
}

3 swagger3常见注释

@Api：用在请求的类上，表示对类的说明 
	tags="说明该类的作用，可以在UI界面上看到的注解" 
    value="该参数没什么意义，在UI界面上也看到，所以不需要配置"
    
@ApiOperation：用在请求的方法上，说明方法的用途、作用 
	value="说明方法的用途、作用" 
    notes="方法的备注说明"

@ApiImplicitParam