swagger-ui

简介

Swagger UI允许任何人(无论您是开发团队还是用户)都可以可视化API资源并与之交互,而无需任何实现逻辑。它是根据您的OpenAPI(以前称为Swagger)规范自动生成的,具有可视化文档,可简化后端实现和客户端使用,号称世界上最流行的API框架。

特点

  • 人性化 允许最终开发人员轻松地进行交互,并尝试API公开的每个操作,以方便使用
  • 通过完整的源代码访问方式以所需方式设置和调整Swagger UI。
  • 所有浏览器支持 Swagger UI 在所有主要浏览器中均可使用。
  • 易于浏览 归类整齐的文档可快速查找并使用资源和端点。

使用SwaggerUI

  • 打开idea 新建boot项目 并编写controller测试是否成功

  • 导入swaage maven文件

    <!-- swagger2 -->
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>2.6.1</version>
            </dependency>
    
    
         <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.6.1</version>
            </dependency>
    
    
  • 配置swaager配置文件

     @Configuration 
    @EnableSwagger2  //开启swagger2
    public class SwaggerConfig {
    

    }

Tags: