|
|
swagger: '2.0'
|
|
|
info:
|
|
|
description: 分布式，大并发，高可用
|
|
|
title: 基础数据API
|
|
|
contact:
|
|
|
name: API Support
|
|
|
url: 'http://www.swagger.io/support'
|
|
|
email: support@swagger.io
|
|
|
license:
|
|
|
name: Apache 2.0
|
|
|
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
|
|
|
version: '1.0'
|
|
|
host: '127.0.0.1:8002'
|
|
|
paths:
|
|
|
/base/area/AddGovArea:
|
|
|
post:
|
|
|
description: 增加行政区划信息
|
|
|
consumes:
|
|
|
- application/x-www-form-urlencoded
|
|
|
produces:
|
|
|
- application/json
|
|
|
tags:
|
|
|
- 行政区划
|
|
|
summary: 增加行政区划信息
|
|
|
parameters:
|
|
|
- type: string
|
|
|
description: 区域代码
|
|
|
name: areaCode
|
|
|
in: query
|
|
|
required: true
|
|
|
- type: string
|
|
|
description: 区域名称
|
|
|
name: areaName
|
|
|
in: query
|
|
|
required: true
|
|
|
- type: string
|
|
|
description: 上级代码
|
|
|
name: masterCode
|
|
|
in: query
|
|
|
required: true
|
|
|
- type: integer
|
|
|
description: 区域类型
|
|
|
name: areaTypeId
|
|
|
in: query
|
|
|
required: true
|
|
|
responses:
|
|
|
'200':
|
|
|
description: OK
|
|
|
schema:
|
|
|
$ref: '#/definitions/general.res'
|
|
|
x-emptylimit:
|
|
|
- areaTypeId
|
|
|
- areaCode
|
|
|
- areaName
|
|
|
- masterCode
|
|
|
x-intlimit:
|
|
|
- areaTypeId
|
|
|
x-lengthlimit:
|
|
|
- areaCode: '6,6'
|
|
|
- masterCode: '6,6'
|
|
|
- areaName: '3:50'
|
|
|
x-rolelimit:
|
|
|
- '1'
|
|
|
/base/area/DeleteGovArea:
|
|
|
post:
|
|
|
description: 删除行政区划信息
|
|
|
consumes:
|
|
|
- application/x-www-form-urlencoded
|
|
|
produces:
|
|
|
- application/json
|
|
|
tags:
|
|
|
- 行政区划
|
|
|
summary: 删除行政区划信息
|
|
|
parameters:
|
|
|
- type: string
|
|
|
description: 区域代码
|
|
|
name: areaCode
|
|
|
in: query
|
|
|
required: true
|
|
|
responses:
|
|
|
'200':
|
|
|
description: OK
|
|
|
schema:
|
|
|
$ref: '#/definitions/general.res'
|
|
|
x-emptylimit:
|
|
|
- areaCode
|
|
|
x-lengthlimit:
|
|
|
- areaCode: '6,6'
|
|
|
x-rolelimit:
|
|
|
- '1'
|
|
|
/base/area/GetGovArea:
|
|
|
get:
|
|
|
description: 获取行政区划信息(单条)
|
|
|
consumes:
|
|
|
- application/x-www-form-urlencoded
|
|
|
produces:
|
|
|
- application/json
|
|
|
tags:
|
|
|
- 行政区划
|
|
|
summary: 获取行政区划信息(单条)
|
|
|
parameters:
|
|
|
- type: string
|
|
|
description: 行政区划码
|
|
|
name: areaCode
|
|
|
in: query
|
|
|
required: true
|
|
|
responses:
|
|
|
'200':
|
|
|
description: OK
|
|
|
schema:
|
|
|
$ref: '#/definitions/base.area.GetGovArea'
|
|
|
x-emptylimit:
|
|
|
- areaCode
|
|
|
x-intlimit:
|
|
|
- areaCode
|
|
|
x-lengthlimit:
|
|
|
- areaCode: '6,6'
|
|
|
x-rolelimit:
|
|
|
- '1'
|
|
|
/base/area/PageGovArea:
|
|
|
get:
|
|
|
description: 获取行政区划信息(列表)
|
|
|
consumes:
|
|
|
- application/x-www-form-urlencoded
|
|
|
produces:
|
|
|
- application/json
|
|
|
tags:
|
|
|
- 行政区划
|
|
|
summary: 获取行政区划信息(列表)
|
|
|
parameters:
|
|
|
- type: integer
|
|
|
description: 第几页
|
|
|
name: page
|
|
|
in: query
|
|
|
required: true
|
|
|
- type: integer
|
|
|
description: 一页显示多少条
|
|
|
name: limit
|
|
|
in: query
|
|
|
required: true
|
|
|
- type: string
|
|
|
description: 行政区划码
|
|
|
name: areaCode
|
|
|
in: query
|
|
|
required: true
|
|
|
responses:
|
|
|
'200':
|
|
|
description: OK
|
|
|
schema:
|
|
|
$ref: '#/definitions/base.area.PageGovArea'
|
|
|
x-emptylimit:
|
|
|
- page
|
|
|
- limit
|
|
|
- areaCode
|
|
|
x-intlimit:
|
|
|
- page
|
|
|
- limit
|
|
|
- areaCode
|
|
|
x-lengthlimit:
|
|
|
- areaCode: '6,6'
|
|
|
x-rolelimit:
|
|
|
- '1'
|
|
|
/base/area/UpdateGovArea:
|
|
|
post:
|
|
|
description: 修改行政区划信息
|
|
|
consumes:
|
|
|
- application/x-www-form-urlencoded
|
|
|
produces:
|
|
|
- application/json
|
|
|
tags:
|
|
|
- 行政区划
|
|
|
summary: 修改行政区划信息
|
|
|
parameters:
|
|
|
- type: string
|
|
|
description: 区域代码
|
|
|
name: areaCode
|
|
|
in: query
|
|
|
required: true
|
|
|
- type: string
|
|
|
description: 区域名称
|
|
|
name: areaName
|
|
|
in: query
|
|
|
required: true
|
|
|
- type: string
|
|
|
description: 上级代码
|
|
|
name: masterCode
|
|
|
in: query
|
|
|
required: true
|
|
|
- type: integer
|
|
|
description: 区域类型
|
|
|
name: areaTypeId
|
|
|
in: query
|
|
|
required: true
|
|
|
responses:
|
|
|
'200':
|
|
|
description: OK
|
|
|
schema:
|
|
|
$ref: '#/definitions/general.res'
|
|
|
x-emptylimit:
|
|
|
- areaTypeId
|
|
|
- areaCode
|
|
|
- areaName
|
|
|
- masterCode
|
|
|
x-intlimit:
|
|
|
- areaTypeId
|
|
|
x-lengthlimit:
|
|
|
- areaCode: '6,6'
|
|
|
- masterCode: '6,6'
|
|
|
- areaName: '3:50'
|
|
|
x-rolelimit:
|
|
|
- '1'
|
|
|
/base/global/AddBaseGlobal:
|
|
|
post:
|
|
|
description: 增加全局变量
|
|
|
consumes:
|
|
|
- application/x-www-form-urlencoded
|
|
|
produces:
|
|
|
- application/json
|
|
|
tags:
|
|
|
- 全局变量
|
|
|
summary: 增加全局变量
|
|
|
parameters:
|
|
|
- type: integer
|
|
|
description: 全局变量分类
|
|
|
name: globalTypeId
|
|
|
in: query
|
|
|
required: true
|
|
|
- type: string
|
|
|
description: 全局变量代码
|
|
|
name: globalCode
|
|
|
in: query
|
|
|
required: true
|
|
|
- type: string
|
|
|
description: 全局变量值
|
|
|
name: globalValue
|
|
|
in: query
|
|
|
required: true
|
|
|
- type: string
|
|
|
description: 全局变量备注
|
|
|
name: globalRemarks
|
|
|
in: query
|
|
|
- type: integer
|
|
|
description: 排序号
|
|
|
name: sortId
|
|
|
in: query
|
|
|
required: true
|
|
|
responses:
|
|
|
'200':
|
|
|
description: OK
|
|
|
schema:
|
|
|
$ref: '#/definitions/general.res'
|
|
|
x-emptylimit:
|
|
|
- globalTypeId
|
|
|
- globalCode
|
|
|
- globalValue
|
|
|
- sortId
|
|
|
x-intlimit:
|
|
|
- globalTypeId
|
|
|
- sortId
|
|
|
x-lengthlimit:
|
|
|
- globalCode: '2,50'
|
|
|
- globalValue: '1,255'
|
|
|
- globalRemarks: '1:500'
|
|
|
x-rolelimit:
|
|
|
- '1'
|
|
|
/base/global/DeleteGovArea:
|
|
|
post:
|
|
|
description: 删除全局变量
|
|
|
consumes:
|
|
|
- application/x-www-form-urlencoded
|
|
|
produces:
|
|
|
- application/json
|
|
|
tags:
|
|
|
- 全局变量
|
|
|
summary: 删除全局变量
|
|
|
parameters:
|
|
|
- type: integer
|
|
|
description: 全局变量ID
|
|
|
name: globalId
|
|
|
in: query
|
|
|
required: true
|
|
|
responses:
|
|
|
'200':
|
|
|
description: OK
|
|
|
schema:
|
|
|
$ref: '#/definitions/general.res'
|
|
|
x-emptylimit:
|
|
|
- globalId
|
|
|
x-rolelimit:
|
|
|
- '1'
|
|
|
/base/global/PageBaseGlobal:
|
|
|
get:
|
|
|
description: 获取全局变量
|
|
|
consumes:
|
|
|
- application/x-www-form-urlencoded
|
|
|
produces:
|
|
|
- application/json
|
|
|
tags:
|
|
|
- 全局变量
|
|
|
summary: 获取全局变量
|
|
|
parameters:
|
|
|
- type: integer
|
|
|
description: 第几页
|
|
|
name: page
|
|
|
in: query
|
|
|
required: true
|
|
|
- type: integer
|
|
|
description: 一页显示多少条
|
|
|
name: limit
|
|
|
in: query
|
|
|
required: true
|
|
|
- type: integer
|
|
|
description: 全局变量分类（全部传0）
|
|
|
name: globalTypeId
|
|
|
in: query
|
|
|
required: true
|
|
|
responses:
|
|
|
'200':
|
|
|
description: OK
|
|
|
schema:
|
|
|
$ref: '#/definitions/base.global.PageBaseGlobal'
|
|
|
x-emptylimit:
|
|
|
- page
|
|
|
- limit
|
|
|
- globalTypeId
|
|
|
x-intlimit:
|
|
|
- page
|
|
|
- limit
|
|
|
- globalTypeId
|
|
|
x-rolelimit:
|
|
|
- '1'
|
|
|
/base/global/UpdateBaseGlobal:
|
|
|
post:
|
|
|
description: 修改全局变量
|
|
|
consumes:
|
|
|
- application/x-www-form-urlencoded
|
|
|
produces:
|
|
|
- application/json
|
|
|
tags:
|
|
|
- 全局变量
|
|
|
summary: 修改全局变量
|
|
|
parameters:
|
|
|
- type: integer
|
|
|
description: 全局变量ID
|
|
|
name: globalId
|
|
|
in: query
|
|
|
required: true
|
|
|
- type: integer
|
|
|
description: 全局变量分类
|
|
|
name: globalTypeId
|
|
|
in: query
|
|
|
required: true
|
|
|
- type: string
|
|
|
description: 全局变量代码
|
|
|
name: globalCode
|
|
|
in: query
|
|
|
required: true
|
|
|
- type: string
|
|
|
description: 全局变量值
|
|
|
name: globalValue
|
|
|
in: query
|
|
|
required: true
|
|
|
- type: string
|
|
|
description: 全局变量备注
|
|
|
name: globalRemarks
|
|
|
in: query
|
|
|
- type: integer
|
|
|
description: 排序号
|
|
|
name: sortId
|
|
|
in: query
|
|
|
required: true
|
|
|
responses:
|
|
|
'200':
|
|
|
description: OK
|
|
|
schema:
|
|
|
$ref: '#/definitions/general.res'
|
|
|
x-emptylimit:
|
|
|
- globalId
|
|
|
- globalTypeId
|
|
|
- globalCode
|
|
|
- globalValue
|
|
|
- sortId
|
|
|
x-intlimit:
|
|
|
- globalId
|
|
|
- globalTypeId
|
|
|
- sortId
|
|
|
x-lengthlimit:
|
|
|
- globalCode: '2,50'
|
|
|
- globalValue: '1,255'
|
|
|
- globalRemarks: '1:500'
|
|
|
x-rolelimit:
|
|
|
- '1'
|
|
|
definitions:
|
|
|
base.area.PageGovArea:
|
|
|
type: object
|
|
|
properties:
|
|
|
success:
|
|
|
description: 是否成功
|
|
|
example: true
|
|
|
type: boolean
|
|
|
message:
|
|
|
description: 返回的消息
|
|
|
example: "操作成功"
|
|
|
type: string
|
|
|
list:
|
|
|
description: 数据列表
|
|
|
example: [{"area_code":"110000","area_level_id":"1","area_name":"北京市","area_type_id":"0","master_code":"100000"},{"area_code":"120000","area_level_id":"1","area_name":"天津市","area_type_id":"0","master_code":"100000"}]
|
|
|
type: object
|
|
|
count:
|
|
|
description: 一共有多少条
|
|
|
example: 2
|
|
|
type: integer
|
|
|
base.area.GetGovArea:
|
|
|
type: object
|
|
|
properties:
|
|
|
success:
|
|
|
description: 是否成功
|
|
|
example: true
|
|
|
type: boolean
|
|
|
message:
|
|
|
description: 返回的消息
|
|
|
example: "获取成功"
|
|
|
type: string
|
|
|
data:
|
|
|
description: 返回的数据
|
|
|
example: {"area_code":"110000","area_level_id":"1","area_name":"北京市","area_type_id":"0","master_code":"100000"}
|
|
|
type: object
|
|
|
base.global.PageBaseGlobal:
|
|
|
type: object
|
|
|
properties:
|
|
|
success:
|
|
|
description: 是否成功
|
|
|
example: true
|
|
|
type: boolean
|
|
|
message:
|
|
|
description: 返回的消息
|
|
|
example: "操作成功"
|
|
|
type: string
|
|
|
list:
|
|
|
description: 数据列表
|
|
|
example: [{"b_use":0,"global_code":"A000923","global_id":1,"global_remarks":"","global_type_id":1,"global_value":"长春市大数据平台（测试修改）","sort_id":1},{"b_use":1,"global_code":"A003","global_id":4,"global_remarks":"dsdf","global_type_id":1,"global_value":"adfsdf","sort_id":6}]
|
|
|
type: object
|
|
|
count:
|
|
|
description: 一共有多少条
|
|
|
example: 2
|
|
|
type: integer
|
|
|
general.res:
|
|
|
type: object
|
|
|
properties:
|
|
|
success:
|
|
|
description: 是否成功
|
|
|
example: true
|
|
|
type: boolean
|
|
|
message:
|
|
|
description: 返回的消息
|
|
|
example: "操作成功"
|
|
|
type: string
|
|
|
|
|
|
|
|
|
|
|
|
|
