spring-boot-starter-swagger
Overview
Starter for swagger 2.x
Version information
Version : 1.1.0.RELEASE
Contact information
Contact : didi
Contact Email : [email protected]
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
- 主索引管理 : 主索引:使用证件类型、证件号码、真实名称生成;域索引:证件号码;域索引类型:证件类型;域编码:单位、应用、区域等唯一标识;
Paths
域索引绑定
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 |
域索引解绑
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 |
电子健康卡绑定
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 |
获得域索引(单个)
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 |
获得域索引列表,返回域索引、域索引类型编码
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 |
根据主索引获得域索引列表,返回域索引、域索引类型名称、域名称
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 |
获得主索引
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 |
注册主索引
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 |
设置默认域索引
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 |
Definitions
Msg
Name | Schema |
---|---|
data optional |
object |
errCode optional |
string |
errMsg optional |
string |
success optional |
boolean |
Security
Authorization
Type : apiKey
Name : TOKEN
In : HEADER