springboot入门swagger

1.Swagger简介

• 号称世界上最流行的API框架

• RestFul ApI文档在线自动生成工具=》API文档与API定义同步更新

• 直接运行，可以在线测试API接口

• 支持多种语言：(Java PHP)

官网：https://swagger.io/

 

在项目使用Swagger需要springbox

• swagger2

• ui

SwaggerUI 特点：

• 无依赖 UI可以在任何开发环境中使用，无论是本地还是在Web端中。

• 人性化 允许最终开发人员轻松地进行交互，并尝试API公开的每个操作，以方便使用。

• 易于浏览 归类整齐的文档可快速查找并使用资源和端点。

• 所有浏览器支持 Swagger UI 在所有主要浏览器中均可使用，以适应各种可能的情况。

• 完全可定制 通过完整的源代码访问方式以所需方式设置和调整Swagger UI。

• 完整的OAS支持 可视化Swagger 2.0或OAS 3.0中定义的API。

2.springboot集成swagger

1. 新建一个SpringBootWeb项目

2. 导入相关依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

3. 配置Swagger==>Config

package com.kuang.config;

import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration  //表明这个一个配置类
@EnableSwagger2 //开启Swagger2
public class SwaggerConfig {
}

4. 运行，但是给我报了一个错

 敢肯定的是版本问题，因为我里面都没写东西，于是降了版本号，我原来的版本号是2.6.1

 降到2.5.4后，成功运行，访问：http://localhost:8080/swagger-ui/index.html