美文网首页
Grails集成swagger1在线接口

Grails集成swagger1在线接口

作者: 枭傲浆糊 | 来源:发表于2018-08-16 09:54 被阅读0次

    swagge简介:通常的项目开发中,开发人员在完成后端功能开发后需要同步维护Api文档,以供前端人员调用。swagger就是一款让你更好的书写API文档的框架。

    1.Grails集成swagger

    1.1添加存储仓库和引入依赖包

    1.2 两种访问方式

    1.启动项目直接访问:http://项目路径/webjars/swagger-ui/3.0.17/index.html?url=/apiDoc/index

    2.添加访问路径:

    (1)在urlMapping中添加"/apiDoc/index"(controller:'apiDoc',action:'getDocuments')

    (2)启动项目访问:http://项目路径/apiDoc/index

    注意:采用第二种访问方式如果出现访问路径问题需要注释build.gradle中的以下代码

    1.3 修改build.gradle防止影响日志打印

    1.4swagger针对不同运行环境进行拦截

    添加拦截类,如:production环境会提示无权访问

    1.5 如需要自定义api页面头部信息,可在application.yml中添加如下代码

    2.常用注解及参数

    @Api()用于类上,标识该类是swagger资源

    @ApiOperation():用于方法,表示http请求的操作,参数说明如下:

        value: 方法说明

        nickname: 对应UrlMapping路径值

        produces: response content type值,不写默认是 application/json

        consumes:  为空即可,应该有默认值

        httpMethod: get post put等

        response:

    @ApilmplicitParams:注释方法,包含一组参数说明

    @ApilmplicitParam:指定一个参数的格式,参数如下:

                     name:参数名

                      value:参数描述

                      required: true 或false ,表示参数是否必传

                      dataType:参数类型

                      defaultValue:参数的默认值

                      paramTyp: header,query,path,body,form固定这几个值之一

    3.demo

    相关文章

      网友评论

          本文标题:Grails集成swagger1在线接口

          本文链接:https://www.haomeiwen.com/subject/olnkbftx.html