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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,271评论 5 466
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,725评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,252评论 0 328
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,634评论 1 270
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,549评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,985评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,471评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,128评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,257评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,233评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,235评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,940评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,528评论 3 302
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,623评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,858评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,245评论 2 344
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,790评论 2 339

推荐阅读更多精彩内容

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