2018-05-22

spring-boot-starter-swagger

<a name="overview"></a>

Overview

Starter for swagger 2.x

Version information

Version : 1.1.0.RELEASE

Contact information

Contact : didi
Contact Email : dyc87112@qq.com

License information

License : Apache License, Version 2.0
License URL : https://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : https://github.com/dyc87112/spring-boot-starter-swagger

URI scheme

Host : localhost:8080
BasePath : /

Tags

  • 主索引管理 : 主索引：使用证件类型、证件号码、真实名称生成；域索引：证件号码；域索引类型：证件类型；域编码：单位、应用、区域等唯一标识；

<a name="paths"></a>

Paths

<a name="domainbindingmasterusingpost"></a>

域索引绑定

POST /indexApi/domainBindingMaster

Description

将域索引与主索引绑定

Parameters

Type Name Description Schema
Header access_token
required 		user access token string
Header timestamp
optional 		access timestamp integer (int32)
FormData cardCode
required 		域索引（证件号码） string
FormData cardType
required 		域索引类型（证件类型） string
FormData domainCode
required 		域编码 string
FormData isDefault
required 		域索引默认标志：1，是；2；否 integer (int32)
FormData masterIndex
required 		主索引 string

Responses

HTTP Code Description Schema
200 OK Msg
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • 主索引管理

Security

Type Name Scopes
apiKey Authorization global

<a name="domainindexunbindusingpost"></a>

域索引解绑

POST /indexApi/domainIndexUnbind

Description

将一个域索引解绑

Parameters

Type Name Description Schema
Header access_token
required 		user access token string
Header timestamp
optional 		access timestamp integer (int32)
FormData cardCode
required 		域索引（证件号码） string
FormData cardType
required 		域索引类型（证件类型） string
FormData domainCode
required 		域编码 string
FormData masterIndex
required 		主索引 string

Responses

HTTP Code Description Schema
200 OK Msg
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • 主索引管理

Security

Type Name Scopes
apiKey Authorization global

<a name="elecodebindingmasterusingpost"></a>

电子健康卡绑定

POST /indexApi/eleCodeBindingMaster

Description

将电子健康卡与主索引绑定，调用[注册主索引]接口后默认调用，其它情况不调用该接口。

Parameters

Type Name Description Schema
Header access_token
required 		user access token string
Header timestamp
optional 		access timestamp integer (int32)
FormData cardCode
required 		域索引（电子健康卡） string
FormData cardType
required 		域索引类型（电子健康卡所属分类） string
FormData domainCode
required 		域编码 string
FormData isDefault
required 		域索引默认标志：1，是；2；否 integer (int32)
FormData masterIndex
required 		主索引 string

Responses

HTTP Code Description Schema
200 OK Msg
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • 主索引管理

Security

Type Name Scopes
apiKey Authorization global

<a name="getdomainindexbymasteranddomainusingpost"></a>

获得域索引（单个）

POST /indexApi/getDomainIndexByMasterAndDomain

Description

根据主索引、域获得域索引。有默认域索引，则返回默认域索引；没有默认域索引，则返回最新的域索引；没有域索引，则失败。

Parameters

Type Name Description Schema
Header access_token
required 		user access token string
Header timestamp
optional 		access timestamp integer (int32)
FormData domainCode
required 		域编码 string
FormData masterIndex
required 		主索引 string

Responses

HTTP Code Description Schema
200 OK Msg
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • 主索引管理

Security

Type Name Scopes
apiKey Authorization global

<a name="getdomainindexlistbydomaincodeusingpost"></a>

获得域索引列表，返回域索引、域索引类型编码

POST /indexApi/getDomainIndexListByDomainCode

Description

根据主索引、域获得域索引列表

Parameters

Type Name Description Schema Default
Header access_token
required 		user access token string
Header timestamp
optional 		access timestamp integer (int32)
FormData domainCode
required 		域编码 string
FormData masterIndex
required 		主索引 string
FormData pageNum
required 		当前页，默认第1页 integer (int32) 1
FormData pageSize
required 		每页条数，默认10条 integer (int32) 10

Responses

HTTP Code Description Schema
200 OK Msg
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • 主索引管理

Security

Type Name Scopes
apiKey Authorization global

<a name="getdomainindexlistbymasterindexcodeusingpost"></a>

根据主索引获得域索引列表，返回域索引、域索引类型名称、域名称

POST /indexApi/getDomainIndexListByMasterIndexCode

Description

根据主索引得域索引列表

Parameters

Type Name Description Schema Default
Header access_token
required 		user access token string
Header timestamp
optional 		access timestamp integer (int32)
FormData masterIndex
required 		主索引 string
FormData pageNum
required 		当前页，为空时默认第1页 integer (int32) 1
FormData pageSize
required 		每页条数，为空时默认10条 integer (int32) 10

Responses

HTTP Code Description Schema
200 OK Msg
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • 主索引管理

Security

Type Name Scopes
apiKey Authorization global

<a name="getmasterindexbydomainusingpost"></a>

获得主索引

POST /indexApi/getMasterIndexByDomain

Description

根据域索引获得主索引

Parameters

Type Name Description Schema
Header access_token
required 		user access token string
Header timestamp
optional 		access timestamp integer (int32)
FormData cardCode
required 		域索引（证件号码） string
FormData cardType
required 		域索引类型（证件类型） string

Responses

HTTP Code Description Schema
200 OK Msg
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • 主索引管理

Security

Type Name Scopes
apiKey Authorization global

<a name="regindexusingpost"></a>

注册主索引

POST /indexApi/regIndex

Description

通过证件类型、证件号码、真实姓名来创建主索引，同时将证件号码、证件类型、域编码保存为域索引，并将主索引域域索引绑定。

Parameters

Type Name Description Schema
Header access_token
required 		user access token string
Header timestamp
optional 		access timestamp integer (int32)
FormData cardCode
required 		证件号码 string
FormData cardType
required 		证件类型 string
FormData domainCode
required 		域编码 string
FormData fullName
required 		真实姓名 string

Responses

HTTP Code Description Schema
200 OK Msg
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • 主索引管理

Security

Type Name Scopes
apiKey Authorization global

<a name="setdefaultdomainindexusingpost"></a>

设置默认域索引

POST /indexApi/setDefaultDomainIndex

Description

将一个索引设置为默认域索引

Parameters

Type Name Description Schema
Header access_token
required 		user access token string
Header timestamp
optional 		access timestamp integer (int32)
FormData cardCode
required 		域索引（证件号码） string
FormData cardType
required 		域索引类型（证件类型） string
FormData domainCode
required 		域编码 string
FormData masterIndex
required 		主索引 string

Responses

HTTP Code Description Schema
200 OK Msg
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • 主索引管理

Security

Type Name Scopes
apiKey Authorization global

<a name="definitions"></a>

Definitions

<a name="msg"></a>

Msg

Name Schema
data
optional 		object
errCode
optional 		string
errMsg
optional 		string
success
optional 		boolean

<a name="securityscheme"></a>

Security

<a name="authorization"></a>

Authorization

Type : apiKey
Name : TOKEN
In : HEADER

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 203,456评论 5赞 477
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,370评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 150,337评论 0赞 337
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,583评论 1赞 273
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,596评论 5赞 365
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,572评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,936评论 3赞 395
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,595评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,850评论 1赞 297
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2赞 321
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,371评论 4赞 318
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,951评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1赞 259
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2赞 342

推荐阅读更多精彩内容

  • Spring Cloud
    Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具（例如配置管理，服务发现，断路器，智...
    卡卡罗2017阅读 134,585评论 18赞 139
  • 2018-05-22
    1.B-数、B+数 B-树 特点： 是一种多路搜索树（并不是二叉的）： 1.定义任意非叶子结点最多只有M个儿子；且...
    ROC_XU的日记本阅读 250评论 0赞 0
  • 风起巷末
    多想就这样看着你 用所有眼睛和所有距离 就像风住了 风又起 那年夏天，我们初相识在操场，那晚，繁星闪烁，像是在恭贺...
    风起巷末阅读 273评论 0赞 0
  • 零题
    年轻真好， 相信说到做到， 喜欢一个人就可以一直陪他， 哪怕流浪。 我去看了你说的大海， 却发现海不是蓝的 以为是...
    南瓜妞阅读 313评论 0赞 0
  • Use fragment identifier - Angular
    Angular use fragment identifier to implement single page...
    Zihowe阅读 193评论 0赞 0