栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

SpringBoot 中集成 Swagger2

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

SpringBoot 中集成 Swagger2

这里写目录标题
      • SwaggerConfig 配置类
      • MyController 控制类
      • User 的 持久类
      • application.properties 配置文件
      • application-dev.properties 配置文件
      • application-pro.properties 配置文件
      • POM.xml 文件中的 Swagger 相关依赖
    • 效果演示
    • 参考目录

测试总览

SwaggerConfig 配置类
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean //配置docket以配置Swagger具体参数
    public Docket docket(Environment environment) {

        Profiles profile = Profiles.of("dev");
        boolean b = environment.acceptsProfiles(profile);
        return new Docket(documentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(b)
                .groupName("ouring")
                .select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                .apis(RequestHandlerSelectors.basePackage("com.ouring.swaggerdemo.controller"))
                .build();

    }




    //配置文档信息
    private ApiInfo apiInfo() {
        Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");
        return new ApiInfo(
                "Swagger学习", // 标题
                "学习演示如何配置Swagger", // 描述
                "v1.0", // 版本
                "http://terms.service.url/组织链接", // 组织链接
                contact, // 联系人信息
                "Apach 2.0 许可", // 许可
                "许可链接", // 许可连接
                new ArrayList<>()// 扩展
        );
    }

}
MyController 控制类
@RestController
@Api(tags = "Controller 控制器")
public class MyController {
    @ApiOperation(value = "limi")
    @GetMapping({"/koma/{name}","/index/{name}"})
    public String index(@PathVariable(name = "name") String name){
        return "hello everyone"+name;
    }

    @GetMapping({"/ouring","/komi"})
    public String ouring(String name){
        return "hello ouring"+name;
    }

    @PostMapping({"/liko","/sama"})
    public User Komi(@RequestBody User user){
        return user;
    }

}
User 的 持久类
@Data
@AllArgsConstructor
@NoArgsConstructor
@ApiModel("用户")
public class User {
    @ApiModelProperty("用户名")
    private String name;
    @ApiModelProperty("密码")
    private String paw;
}
application.properties 配置文件
spring.profiles.active=dev
application-dev.properties 配置文件
server.port=8081
application-pro.properties 配置文件
server.port=8082
POM.xml 文件中的 Swagger 相关依赖
 
        
            io.springfox
            springfox-swagger2
            2.9.2
        

        
        
            io.springfox
            springfox-swagger-ui
            2.9.2
        
效果演示

参考目录

非常详细的 笔记
https://blog.csdn.net/weixin_44449838/article/details/108713248

狂神
https://www.bilibili.com/video/BV1PE411i7CV?p=49

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/302180.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号