springboot中集成Swagger

Swagger的使用

一.springboot中使用Swagger

1.去maven的官网上上找swagger的依赖

maven官网,搜索springfox,这是两个必须的Springfox Swagger2和Springfox UI的依赖添加到你的pom文件。
maven依赖
pom文件


2.编写你的Swagger配置文件类

编写Swagger的配置类
注意点
1. 用@EnableSwagger2,开启swagger2
  1. 向容器中添加Docket,这是Swagger的docket实例
  2. 如果你想有几个接口组,多注入几个docket实例到spring容器
    Swagger配置类
//作者信息
private static final Contact DEFAULT_CONTACT = new Contact("夏烨", "https://segmentfault.com/u/xiaye_5e702b22aea45", "1159395895@qq.com");

    //配置swagger 的 docket实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //增加组名
                .groupName("xiaye")
                //链式的编程,下面是一组
                .select()
                //指定要扫描的包
                .apis(RequestHandlerSelectors.basePackage("com.xy.hms.controller"))
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfo(
                "night的swagger文档"
                , "swagger学习测试"
                , "1.0"
                , "urn:tos"
                , DEFAULT_CONTACT
                , "Apache 2.0"
                , "http://www.apache.org/licenses/LICENSE-2.0"
                , new ArrayList());

    }

3.启动项目,访问swagger-ui.html

页面显示

4.实体类上的注释

  1. @ApiModel(value="") 对实体类的注释
  2. @ApiModelProperty(value="") 对实体属性的注释
    在这里插入图片描述
    前提是你的controller返回了这个实体对象,那么在model中就可以找到对应的注释

5.contrller上的注释

1.@Api(tags = "用户登录控制类") 对controller的注释
2.@ApiOperation("登录控制") 这是对方法的注释

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值