Grails集成swagger1在线接口

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,879评论 19 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 176,015评论 25 709
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 47,126评论 6 342
  • 今日体验:今天整理下思路在做完老店二店的报表,每天给自己制定计划,完成目标,一日事一日毕。
    A郑淑英阅读 921评论 0 0
  • 现在,让我们怀着愉悦而放松的心情为今天的好种子浇水施肥晒太阳️️… 我近期最想实现的一个目标愿望是: ❤运用金刚智...
    希热星增阅读 1,031评论 0 0

友情链接更多精彩内容