Swagger基本使用快速上手

简介: Swagger简介1、是一款让你更好的书写API文档规范且完整的框架。2、提供描述、生产、消费和可视化RESTful Web Service。3、是由庞大工具集合支撑的形式化规范。这个集合涵盖了从终端用户接口、底层代码库到商业API管理的方方面面。

Springboot集成Swagger


1.创建SpringBoot项目 引入Swagger坐标


需要引入两个Swagger坐标 分别是springfox-swagger2 springfox-swagger-ui

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


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

2.编写Swagger配置类


@Configuration 声明SwaggerConfiguration为配置类

@EnableSwagger2注解开启Swagger2

先配置Swagger信息

再配置Swagger的Docket的bean实例

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    //配置Swagger的Docket的bean实例
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())  //配置Swagger信息
                .select()
                /**
                 * apis():指定扫描的接口
                 *  RequestHandlerSelectors:配置要扫描接口的方式
                 *       basePackage:指定要扫描的包
                 *       any:扫面全部
                 *       none:不扫描
                 *       withClassAnnotation:扫描类上的注解(参数是类上注解的class对象)
                 *       withMethodAnnotation:扫描方法上的注解(参数是方法上的注解的class对象)
                 */
                .apis(RequestHandlerSelectors.basePackage("com.czxy"))
                /**
                 * paths():过滤路径
                 *  PathSelectors:配置过滤的路径
                 *      any:过滤全部路径
                 *      none:不过滤路径
                 *      ant:过滤指定路径:按照按照Spring的AntPathMatcher提供的match方法进行匹配
                 *      regex:过滤指定路径:按照String的matches方法进行匹配
                 */
                .paths(PathSelectors.any())
                .build();
    }
    //配置Swagger信息
    private ApiInfo apiInfo(){
        return new ApiInfo(
                "陶然同学。",
                "我的Swagger API文档",
                "1.0",
                "https://blog.csdn.net/weixin_45481821?spm=1018.2226.3001.5343",
                new Contact("陶然同学。","https://blog.csdn.net/weixin_45481821?spm=1018.2226.3001.5343","71829230@qq.com"),
                "Apache 2.0",
                "https://blog.csdn.net/weixin_45481821?spm=1018.2226.3001.5343",
                new ArrayList<VendorExtension>()
        );
    }
}

3.编写Controller

@RestController
public class HelloController {
    @RequestMapping("/hello")
    public String hello(){
        return "hello";
    }
}

4.测试进入Swagger页面


路径:http://localhost:8080/swagger-ui.html/

微信图片_20220523230952.png


常用注解


@ApiModel:为类添加注释


@ApiModelProperty:为类属性添加注释


@Api:为Controller添加注释


@ApiOperation:为Controller方法添加注释


@ApiParam:为Controller方法参数添加注释


测试Swagger


编写Controller测试传参

    @PostMapping("/username")
    public User getUserName(User user){
        return user;
    }

点击try it out 填写用户名 和 密码 再点击Execute发送 下面就能看到返回的结果

微信图片_20220523231223.png


参考文档


Swagger官网:image.png


总结


       Swagger不用深入学习  会基本的使用就可以了 配置类不懂也没关系 粘贴复制就行

相关文章
Swagger基本使用与RestTemplate发送http接口测试
Swagger基本使用与RestTemplate发送http接口测试
177 1
|
JSON 前端开发 测试技术
前后端接口测试神器Swagger基本使用(下)
前后端接口测试神器Swagger基本使用
前后端接口测试神器Swagger基本使用(下)
|
前端开发 搜索推荐 Java
前后端接口测试神器Swagger基本使用(上)
前后端接口测试神器Swagger基本使用
前后端接口测试神器Swagger基本使用(上)
|
8月前
|
JSON Java API
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档——Swagger2 的使用
本文详细介绍了Swagger2的使用方法,包括在Spring Boot项目中的配置与应用。重点讲解了Swagger2中常用的注解,如实体类上的`@ApiModel`和`@ApiModelProperty`,Controller类上的`@Api`、`@ApiOperation`以及参数上的`@ApiParam`等。通过示例代码展示了如何为实体类和接口添加注解,并在页面上生成在线接口文档,实现接口测试。最后总结了Swagger的优势及其在项目开发中的重要性,提供了课程源代码下载链接供学习参考。
639 0
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档——Swagger2 的使用
|
8月前
|
缓存 Java API
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档——Swagger2 的配置
本文介绍了在Spring Boot中配置Swagger2的方法。通过创建一个配置类,添加`@Configuration`和`@EnableSwagger2`注解,使用Docket对象定义API文档的详细信息,包括标题、描述、版本和包路径等。配置完成后,访问`localhost:8080/swagger-ui.html`即可查看接口文档。文中还提示了可能因浏览器缓存导致的问题及解决方法。
1007 0
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档——Swagger2 的配置
|
8月前
|
Java Maven 微服务
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档——Swagger2 的 maven 依赖
在项目中使用Swagger2工具时,需导入Maven依赖。尽管官方最高版本为2.8.0,但其展示效果不够理想且稳定性欠佳。实际开发中常用2.2.2版本,因其稳定且界面友好。以下是围绕2.2.2版本的Maven依赖配置,包括`springfox-swagger2`和`springfox-swagger-ui`两个模块。
342 0
|
8月前
|
前端开发 Java API
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档—— Swagger 简介
第6课介绍了在Spring Boot中集成Swagger2以展示在线接口文档的方法。随着前后端分离架构的发展,API文档成为连接前端与后端开发的重要纽带。然而,代码更新频繁导致文档难以同步维护,Swagger2解决了这一问题。通过Swagger,在线API文档不仅方便了接口调用方查看和测试,还支持开发者实时测试接口数据。本文使用Swagger 2.2.2版本,讲解如何在Spring Boot项目中导入并配置Swagger2工具,从而高效管理接口文档。
300 0
|
数据可视化 Java API
Spring Boot与Swagger的集成
Spring Boot与Swagger的集成
|
Java API 开发者
在Spring Boot中集成Swagger API文档
在Spring Boot中集成Swagger API文档
|
12月前
|
Java 测试技术 API
详解Swagger:Spring Boot中的API文档生成与测试工具
详解Swagger:Spring Boot中的API文档生成与测试工具
889 4

热门文章

最新文章

下一篇
oss云网关配置