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不用深入学习  会基本的使用就可以了 配置类不懂也没关系 粘贴复制就行

相关文章
|
6月前
Swagger基本使用与RestTemplate发送http接口测试
Swagger基本使用与RestTemplate发送http接口测试
80 1
|
JSON 前端开发 测试技术
前后端接口测试神器Swagger基本使用(下)
前后端接口测试神器Swagger基本使用
前后端接口测试神器Swagger基本使用(下)
|
前端开发 搜索推荐 Java
前后端接口测试神器Swagger基本使用(上)
前后端接口测试神器Swagger基本使用
前后端接口测试神器Swagger基本使用(上)
|
4月前
|
数据可视化 Java API
Spring Boot与Swagger的集成
Spring Boot与Swagger的集成
|
4月前
|
Java API 开发者
在Spring Boot中集成Swagger API文档
在Spring Boot中集成Swagger API文档
|
1月前
|
SQL JSON Java
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和PageHelper进行分页操作,并且集成Swagger2来生成API文档,同时定义了统一的数据返回格式和请求模块。
54 1
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
|
1月前
|
前端开发 Java 程序员
springboot 学习十五:Spring Boot 优雅的集成Swagger2、Knife4j
这篇文章是关于如何在Spring Boot项目中集成Swagger2和Knife4j来生成和美化API接口文档的详细教程。
102 1
|
2月前
|
前端开发 Java Spring
【非降版本解决】高版本Spring boot Swagger 报错解决方案
【非降版本解决】高版本Spring boot Swagger 报错解决方案
|
2月前
|
Java Spring
springboot 集成 swagger 2.x 和 3.0 以及 Failed to start bean ‘documentationPluginsBootstrapper‘问题的解决
本文介绍了如何在Spring Boot项目中集成Swagger 2.x和3.0版本,并提供了解决Swagger在Spring Boot中启动失败问题“Failed to start bean ‘documentationPluginsBootstrapper’; nested exception is java.lang.NullPointerEx”的方法,包括配置yml文件和Spring Boot版本的降级。
springboot 集成 swagger 2.x 和 3.0 以及 Failed to start bean ‘documentationPluginsBootstrapper‘问题的解决
|
3月前
|
Java API Spring
springboot集成swagger
这篇文章介绍了如何在Spring Boot项目中集成Swagger 2.10.0来生成API文档,包括添加依赖、编写配置类、创建接口文档,并使用Knife4j美化Swagger界面。
下一篇
无影云桌面