您现在的位置是：首页 > 其它

当前栏目

sprigboot--组合 swagger

-- 组合 swagger

2023-09-27 14:25:19 时间

maven 依赖

 <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
</dependency>

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
</dependency>

添加swagger配置文件

package com.config;

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

//配置到springboot
@Configuration
//开启swagger---页面地址 /swagger-ui.html
@EnableSwagger2
public class SwaggerConfig {
}

----------------------------------------------------以上swagger就启动起来了--------------------------------------------------------------------

配置swagger

1、配置网页展示的信息

package com.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

//配置到springboot
@Configuration
//开启swagger---页面地址 /swagger-ui.html
@EnableSwagger2
public class SwaggerConfig {
    //配置了Swagger 的Docket的bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }

    //配置Swagger信息=apiinfo
    private ApiInfo apiInfo(){
//        作者信息A
        Contact contact =new Contact("刘锴傧https://www.cnblogs.com/kaibindirver/p/15025758.html",
                "https://i.cnblogs.com/posts/edit-done;postId=14948036",
                "tomcat8888@163.com");
        return new ApiInfo(
                "凯宾斯基SwaggerAPi文档",
                "这个是我文档的描述",
                "v1.01",
                "https://i.cnblogs.com/posts/edit-done;postId=14948036",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());

    }
}

2、配置扫描接口-和判断当前环境是否开启 swagger网站访问

设置2个不同环境的配置文件见: https://www.cnblogs.com/kaibindirver/p/15025758.html

package com.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

//配置到springboot
@Configuration
//开启swagger---页面地址 /swagger-ui.html
@EnableSwagger2
public class SwaggerConfig {
    //配置了Swagger 的Docket的bean实例
    @Bean
    public Docket docket(Environment environment){

//        设置要显示的Swagger环境
        Profiles profiles= Profiles.of("dev","test");
//获取当前的环境
        boolean flag = environment.acceptsProfiles(profiles);

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //控制是否开启swagger 设置为false 浏览器就无法访问
                .enable(flag)
                .select()
//        RequestHandlerSelectors配置要扫描接口的方式，下面是扫描包
                .apis(RequestHandlerSelectors.basePackage("com.control"))
                //        none()不扫描,打开swagger是空的
//                .apis(RequestHandlerSelectors.none())
                //只扫描/kai开头的接口
//                .paths(PathSelectors.ant("/kai/**"))
                .build();
    }

    //配置Swagger信息=apiinfo
    private ApiInfo apiInfo(){
//        作者信息A
        Contact contact =new Contact("刘锴傧",
                "https://i.cnblogs.com/posts/edit-done;postId=14948036",
                "tomcat8888@163.com");
        return new ApiInfo(
                "凯宾斯基SwaggerAPi文档",
                "这个是我文档的描述",
                "v1.01",
                "https://i.cnblogs.com/posts/edit-done;postId=14948036",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());

    }
}

设置分组的方法加多一个bean

package com.config;
 
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
import java.util.ArrayList;
 
//配置到springboot
@Configuration
//开启swagger---页面地址 /swagger-ui.html
@EnableSwagger2
public class SwaggerConfig {
 
    //配置了Swagger 的Docket的bean实例
    @Bean
    public Docket docket(Environment environment){
 
//        设置要显示的Swagger环境
        Profiles profiles= Profiles.of("dev","test");
        boolean flag = environment.acceptsProfiles(profiles);
 
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
//                设置分组
                .groupName("分组-01")
                //控制是否开启swagger 设置为false 浏览器就无法访问
                .enable(flag)
                .select()
//        RequestHandlerSelectors配置要扫描接口的方式，下面是扫描包
                .apis(RequestHandlerSelectors.basePackage("com.control"))
                //        none()不扫描,打开swagger是空的
//                .apis(RequestHandlerSelectors.none())
                //只扫描/kai开头的接口
//                .paths(PathSelectors.ant("/kai/**"))
                .build();
    }
 
 
    //下面是再创建多一个相同的函数，实现接口分组
    @Bean
    public Docket docket2(Environment environment){
 
//        设置要显示的Swagger环境
        Profiles profiles= Profiles.of("dev","test");
        boolean flag = environment.acceptsProfiles(profiles);
 
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
//                设置分组
                .groupName("分组-02")
                .enable(flag)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.control"))
                .build();
    }
 
    //配置Swagger信息=apiinfo
    private ApiInfo apiInfo(){
//        作者信息A
        Contact contact =new Contact("刘锴傧",
                "https://i.cnblogs.com/posts/edit-done;postId=14948036",
                "tomcat8888@163.com");
        return new ApiInfo(
                "凯宾斯基SwaggerAPi文档",
                "这个是我文档的描述",
                "v1.01",
                "https://i.cnblogs.com/posts/edit-done;postId=14948036",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());
 
    }
}

给接口的请求参数和接口命名

给返回的实体类或post接受映射的实体类命名

package com.dao.entity;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;

@NoArgsConstructor
@AllArgsConstructor
@ToString
@Data //注意要有get、set方法
@ApiModel("用户实体类")
public class User {
    @ApiModelProperty("用户名")
    private String name;
    @ApiModelProperty("用户年龄")
    private String age;
}

给接口命名

import com.dao.entity.User;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.*;


@RestController
@Api(tags = "用户相关接口", description = "提供用户相关的 Rest API")
public class Swagger {

    @ApiOperation("post请求提交用户信息")
    @PostMapping("/aaa")
    public User delete_User3 (@ApiParam("用户信息") @RequestBody User user) {
        return new User();
    }

    @ApiOperation("get请求获取用户信息")
    @GetMapping("/bbb")
    public User delete_User4 (
            @ApiParam(name="用户名",required = true) @RequestParam(value="name") String name,
            @ApiParam("性别") @RequestParam(value="sex") int sex) {
        return new User();
    }
}

可以参考下 : https://blog.csdn.net/zhongzk69/article/details/94987568 （里面有统一配置400 500 的接口响应）

以上看得是狂神的: https://www.bilibili.com/video/BV1Y441197Lw?from=search&seid=17321077544629926329

猜你喜欢

东部分布式光伏迎来发展高潮
【BZOJ3817/UOJ42】Sum（类欧）
设计模式(四)--装饰者模式(Decorator/Wrapper Pattern)
数据科学家和大数据计数人员工具包
计算机视觉+人工智能面试笔试总结——模型压缩部署
堆排序实践
红外目标图像中阈值切割方法的比較与研究
智能电视安全防御水平远落后于手机和PC
每日Ubuntu小技巧 —— 让Windows访问你文件的最简单的方法
[转]让iframe自适应高度-真正解决
Excel之定位和查找
学习Bootstrap
为自己的2017年定个计划
slenium的xpath几种定位方式
SQL与ORACLE中存储过程调用存储过程返回的结果集插入到临时表写法
【微信小程序】-- 页面处理总结（三十一）
Perl处理数据(二)：tr和y///

相关主题

zl程序教程

当前栏目

sprigboot--组合 swagger

----------------------------------------------------以上swagger就启动起来了--------------------------------------------------------------------

相关文章