一看就懂之Swagger神器（Java版）

文章目录

前言
一、Swagger是什么？
二、使用步骤
- 1.引入swagger依赖
- 2.编写代码
总结

前言

提示：这里可以添加本文要记录的大概内容：

例如：随着人工智能的不断发展，机器学习这门技术也越来越重要，很多人都开启了学习机器学习，本文就介绍了机器学习的基础内容。

一、Swagger是什么？

Swagger 是一个规范且完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

支持 API 自动生成同步的在线文档：使用 Swagger 后可以直接通过代码生成文档，不再需要自己手动编写接口文档了，对程序员来说非常方便，可以节约写文档的时间去学习新技术。
2.提供 Web 页面在线测试 API：光有文档还不够，Swagger 生成的文档还支持在线测试。参数和格式都定好了，直接在界面上输入参数对应的值即可在线测试接口。

二、使用步骤 1.引入swagger依赖


        
            io.springfox
            springfox-swagger2
            2.9.2
        

        
            io.springfox
            springfox-swagger-ui
            2.9.2

2.编写代码

代码如下（示例）：

新建3个配置文件，目的是：如果指定开发环境，即可以访问swagger-ui界面，当指定生产环境，无法访问swagger-ui界面

application.properties

spring.profiles.active=pro

application-dev.properties(开发环境)

## 开发环境
server.port=8081

application-pro.properties(生产环境)

## 生产环境
server.port=8082

User类

@ApiModel("用户实体类")
@NoArgsConstructor
@AllArgsConstructor
public class User {

    @ApiModelProperty("用户名")
    public String userName;

    @ApiModelProperty("密码")
    public String passWord;
}

Controller类

@RestController
@RequestMapping("/user")
@Api(tags = "用户模块控制器类",description = "此处放一些描述信息...")
public class UserController {

    @GetMapping("/get")
    //get 无参
    public User getUser(){
        return  new User();
    }

    @GetMapping("/get2")
    //get 有参
    public User getUser2(String userName,String password){
        User user = new User();
        user.userName = userName;
        user.passWord = password;
        return  user;
    }

    @ApiOperation("post测试类")
    @PostMapping("/post")
    //post 有参
    public User postUser(@RequestBody @ApiParam("用户") User user){
        return  user;
    }
}

swagger配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket docket(Environment environment) {
        Profiles profiles = Profiles.of("pro");
        //判断是否是在设定环境
        boolean flag = environment.acceptsProfiles(profiles);
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //决定swagger展示与否，生产环境不能展示
                .enable(flag)
                .groupName("用户模块")
                .select()
                //指定包名 basePackage
                .apis(RequestHandlerSelectors.basePackage("com.tao.swagger.controller"))
                //再次过滤（根据接口过滤）
                .paths(PathSelectors.ant("/user/**"))
                .build();
    }

    @Bean
    public Docket docket02(Environment environment) {
        Profiles profiles = Profiles.of("pro");
        //判断是否是在设定环境
        boolean flag = environment.acceptsProfiles(profiles);
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("支付模块")
                //决定swagger展示与否，生产环境不能展示
                .enable(flag)
                ;
    }

    @Bean
    public Docket docket03(Environment environment) {
        Profiles profiles = Profiles.of("pro");
        //判断是否是在设定环境
        boolean flag = environment.acceptsProfiles(profiles);
        //判断是否是在设定环境
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("订单模块")
                //决定swagger展示与否，生产环境不能展示
                .enable(flag)
                ;
    }

    private ApiInfo apiInfo() {
        //contact 维护接口人信息
        Contact contact = new Contact("匿名", "https://www.bilibili.com/video/BV1Y441197Lw?p=2", "tao3348197787@163.com");
        return new ApiInfo(
                //标题
                "飞星写java",
                //描述
                "增加注释，实时更新，在线测试",
                //版本
                "v1.0",
                //服务条款网址
                "urn:tos",
                //维护人信息
                contact,
                //许可
                "Apache 2.0",
                //许可链接
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());
        //如果不想用那么多参数，可以用下边这种自定义参数
        //        new ApiInfoBuilder().contact().title().description().version().build();
    }
}

马上来查看效果吧：
访问地址:

http://localhost:8082/swagger-ui.html

效果展示

这就是首页的样子，右上角是模块，上边是一些信息，下班是各个接口

这个即是针对某个接口的在线测试，输入参数，返回响应结果。

总结

总的来说，swagger已经成为程序员必不可缺的调试工具，如果想要详细源码或者不懂的地方关注公众号，我来帮你解答~

有惊喜哟~

一看就懂之Swagger神器（Java版）

Java相关栏目本月热门文章