springboot集成swagger

最新推荐文章于 2025-01-21 09:36:24 发布

还有文学梦吧

最新推荐文章于 2025-01-21 09:36:24 发布

阅读量154

点赞数 1

分类专栏： springboot

本文链接：https://blog.youkuaiyun.com/fxy12333/article/details/106721327

版权

springboot 专栏收录该内容

3 篇文章

订阅专栏

本文详细介绍如何在SpringBoot项目中集成Swagger2，包括在pom文件中添加依赖、配置SwaggerConfig类以及使用@Api和@ApiOperation等注解来文档化API。通过示例代码展示如何创建RESTful API并使用Swagger UI进行测试。

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

在pom文件添加依赖

<!-- swagger -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.9.2</version>
		</dependency>
		<!-- swagger-ui -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>2.9.2</version>
		</dependency>
	</dependencies>

配置swaggerconfig类

@Configuration
@EnableSwagger2  //开启swagger
public class SwaggerConfig {
    @Bean
    public Docket docker() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
		//作者信息
        Contact contact = new Contact("付新宇","846510744@qq.com","846510744@qq.com");
        return new ApiInfo(
                "springbootdome测试接口",  //名字
                "第一个springboot程序", //描述
                "1.0", //版本号
                "www.baidu.com",
                contact,
                "fxy",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList()
        );
    }
}

注解说明

@Api("查询全部")
@RequestMapping("/list")
@RestController
public class controller {
@Autowired
private NoticeService noticeService;
    @GetMapping("/list")
    @ApiOperation(value="查询用户")
    public List<Notice> list(@RequestParam(defaultValue = "1",value = "pageNum") Integer pageNum){
        PageHelper.startPage(pageNum,3);
    List<Notice> listNotice =noticeService.list();
        return listNotice;
    }
}