REST接口集成Swagger

最新推荐文章于 2022-05-23 17:45:22 发布

mickey198724

最新推荐文章于 2022-05-23 17:45:22 发布

阅读量654

点赞数

CC 4.0 BY-SA版权

分类专栏： Java 文章标签： REST Swagger

本文链接：https://blog.youkuaiyun.com/mickey198724/article/details/83585646

Java 专栏收录该内容

7 篇文章

订阅专栏

本文详细介绍了如何在Spring Boot项目中集成Swagger，包括添加依赖、创建配置类及注解修改，实现RESTful API的文档自动生成，提高开发效率。

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

添加pom依赖

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

添加swaggerConfig类

注：spring配置文件中必须包含swaggerconfig类所在的包：

<context:component-scan base-package="com.xxl.job.admin.controller,com.xxl.job.admin.scan" />

@Configuration
@EnableWebMvc
@EnableSwagger2
@ComponentScan(basePackages = { "com.sts.rest.controller" })
public class SwaggerConfig {

	@Bean
	public Docket platformApi() {
		return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).forCodeGeneration(true);
	}

	private ApiInfo apiInfo() {
		return new ApiInfoBuilder().title("xxx-API").description("©2017 Copyright. Powered By xxx.")
				// .termsOfServiceUrl("")
				.contact(new Contact("xxx-API", "", "xxxxx@qq.com")).license("xxx Group").version("1.0")
				.build();
	}

}

修改spring配置

Springmvc-context.xml文件中添加配置：

<mvc:default-servlet-handler />

<mvc:annotation-driven />

修改接口注解

@ApiOperation(value = "任务管理页面初始化")
@RequestMapping(value="/index",method={RequestMethod.POST, RequestMethod.GET})
@ResponseBody
public Map<String, Object> index(@RequestParam(required = false, defaultValue = "-1") int jobGroup) {

	// package result
	Map<String, Object> maps = new HashMap<String, Object>();		    
	return maps;
}