美文网首页我爱编程
2018-05-22

2018-05-22

作者: 一叶之秋水长天 | 来源:发表于2018-05-22 11:14 被阅读0次

    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

    相关文章

      网友评论

        本文标题：2018-05-22

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

        延伸阅读

        深度阅读

        • 您也可以注册成为美文阅读网的作者，发表您的原创作品、分享您的心情！

        栏目导航

        热点阅读

        我爱编程

        关于我们|服务条款|联系我们|2018-05-22|投稿指南|网站地图|RSS订阅|排版工具|手机版

        提供经典美文摘抄,优美散文欣赏,现代诗歌精选,短篇小说,心情随笔,表白情书范文,故事会在线阅读欣赏

        Copyright © 2014-2023 Haomeiwen.com All Rights Reserved. 好美文阅读网 版权所有

        备案信息：桂公网安备 45052102000051号 · 桂ICP备13007215号-3

        本站所收录作品、热点评论等信息部分来源互联网，目的只是为了系统归纳学习和传递资讯

        所有作品版权归原创作者所有，与本站立场无关，如不慎侵犯了你的权益，请联系我们告知，我们将做删除处理！