swagger 注释方式编写接口文档


介绍

  swagger用注解的方式生成接口文档,减少工作量

使用

  首先需要引入jar

  

 <!-- 引入swagger2 -->
        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>1.8.0.RELEASE</version>
        </dependency>

  

  然后在controller中引入注解

  

@Api(value ="/login" ,tags={"登录注册"})

  在方法上也引入注解

  

    

 @ApiOperation("用户登录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "tel",value="手机号",required = true),
            @ApiImplicitParam(name = "password",value="密码",required = true)
    })

效果

  通过访问本地 http://localhost:9004/swagger-ui.html#/ 既可以看到生成的接口文档的效果

  

优质内容筛选与推荐>>
1、js获取地理位置(百度地图api)
2、【Linux基础】tar.xz文件如何解压
3、IO系统的功能和层次模型
4、一百行代码爬取漫画喵
5、Git命令非主流札记


长按二维码向我转账

受苹果公司新规定影响,微信 iOS 版的赞赏功能被关闭,可通过二维码转账支持公众号。

    阅读
    好看
    已推荐到看一看
    你的朋友可以在“发现”-“看一看”看到你认为好看的文章。
    已取消,“好看”想法已同步删除
    已推荐到看一看 和朋友分享想法
    最多200字,当前共 发送

    已发送

    朋友将在看一看看到

    确定
    分享你的想法...
    取消

    分享想法到看一看

    确定
    最多200字,当前共

    发送中

    网络异常,请稍后重试

    微信扫一扫
    关注该公众号





    联系我们

    欢迎来到TinyMind。

    关于TinyMind的内容或商务合作、网站建议,举报不良信息等均可联系我们。

    TinyMind客服邮箱:support@tinymind.net.cn