使用swagger2构建短视频后端api接口文档

概览

欢迎访问短视频接口文档，这里是描述信息

版本信息

版本 : 1.0

联系方式

名字 : imooc-Nathan
邮箱 : scau_zns@163.com

URI scheme

域名 : 127.0.0.1:22008
基础路径 : /ctm01ipac

资源

Common-controller

Common Controller

findDataDict

POST /common/findDataDict

参数

类型	名称	说明	类型
Body	findDataDictVO 必填	findDataDictVO	FindDataDictVO

响应

HTTP代码	说明	类型
200	OK	BaseResult«object»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/common/findDataDict

请求 body

json :
{
  "typeCode" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

getImageStream

GET /common/getImageStream.do

响应

HTTP代码	说明	类型
200	OK	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

*/*

HTTP请求示例

请求 path

/common/getImageStream.do

上传人脸图片

POST /uploadImage

响应

HTTP代码	说明	类型
200	OK	BaseResult«object»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/uploadImage

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

Custom-library-controller

名单库人员

新增自定义库信息(单个新增)

POST /customLibrary/addCustomLibraryInfo

参数

类型	名称	说明	类型
Body	addPersonParams 可选	addPersonParams	AddPersonParams

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/customLibrary/addCustomLibraryInfo

请求 body

json :
{
  "address" : "string",
  "bornTime" : "string",
  "certificateNumber" : "string",
  "certificateType" : "string",
  "documentNum" : "string",
  "extendField1" : "string",
  "extendField2" : "string",
  "extendField3" : "string",
  "humanId" : "string",
  "imageData" : "string",
  "imageUrl" : "string",
  "name" : "string",
  "nation" : "string",
  "nativeCountyCode" : "string",
  "personLibId" : "string",
  "registerGender" : "string",
  "reponsibilityPolice" : "string",
  "reponsibilityPoliceAddress" : "string",
  "reponsibilityPoliceNum" : "string",
  "residenceCountyCode" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

信息补全

POST /customLibrary/customLibraryComplement

参数

类型	名称	说明	类型
Body	queryPersonByAttrWithPageParams 必填	queryPersonByAttrWithPageParams	名单库查询参数

响应

HTTP代码	说明	类型
200	OK	BaseResult«string»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/customLibrary/customLibraryComplement

请求 body

json :
{
  "beginTime" : "string",
  "certificateNumber" : "string",
  "certificateType" : "string",
  "endTime" : "string",
  "humanIds" : "string",
  "name" : "string",
  "nativeCountyCode" : "string",
  "pageNo" : 0,
  "pageSize" : 0,
  "personLibId" : "string",
  "registerGender" : "string",
  "residenceCountyCode" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "string",
  "msg" : "string",
  "type" : 0
}

删除名单库人员

POST /customLibrary/delCustomLibraryInfo

参数

类型	名称	说明	类型
Body	delPersonParams 可选	delPersonParams	DelPersonParams

响应

HTTP代码	说明	类型
200	OK	BaseResult«string»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/customLibrary/delCustomLibraryInfo

请求 body

json :
{
  "humanId" : "string",
  "personLibId" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "string",
  "msg" : "string",
  "type" : 0
}

downloadCustomTemplate

POST /customLibrary/downloadCustomTemplate

响应

HTTP代码	说明	类型
200	OK	BaseResult«string»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/customLibrary/downloadCustomTemplate

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "string",
  "msg" : "string",
  "type" : 0
}

分析人脸图片

POST /customLibrary/findFacesFromUploadPic

参数

类型	名称	说明	类型
Body	imageAnalysisParams 可选	imageAnalysisParams	图片分析

响应

HTTP代码	说明	类型
200	OK	BaseResult«ImageAnalysisDataResp»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/customLibrary/findFacesFromUploadPic

请求 body

json :
{
  "imageData" : "string",
  "imageUrl" : "string",
  "returnAttributes" : true
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : {
    "list" : [ {
      "faceImageUrl" : "string",
      "faceRect" : {
        "height" : 0.0,
        "width" : 0.0,
        "x" : 0.0,
        "y" : 0.0
      },
      "modelData" : "string",
      "recommendFaceRect" : {
        "height" : 0.0,
        "width" : 0.0,
        "x" : 0.0,
        "y" : 0.0
      }
    } ],
    "total" : 0
  },
  "msg" : "string",
  "type" : 0
}

importCustomData

POST /customLibrary/importCustomData

参数

类型	名称	说明	类型
Query	personLibId 必填	personLibId	string

响应

HTTP代码	说明	类型
200	OK	BaseResult«string»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/customLibrary/importCustomData

请求 query

json :
{
  "personLibId" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "string",
  "msg" : "string",
  "type" : 0
}

名单库人员列表

POST /customLibrary/listCustomLibraryInfo

参数

类型	名称	说明	类型
Body	queryPersonByAttrWithPageParams 可选	queryPersonByAttrWithPageParams	名单库查询参数

响应

HTTP代码	说明	类型
200	OK	BaseResult«ArtemisApiBasePage«QueryPersonByAttrWithPageResp»»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/customLibrary/listCustomLibraryInfo

请求 body

json :
{
  "beginTime" : "string",
  "certificateNumber" : "string",
  "certificateType" : "string",
  "endTime" : "string",
  "humanIds" : "string",
  "name" : "string",
  "nativeCountyCode" : "string",
  "pageNo" : 0,
  "pageSize" : 0,
  "personLibId" : "string",
  "registerGender" : "string",
  "residenceCountyCode" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : {
    "list" : [ {
      "bornTime" : "string",
      "certificateNumber" : "string",
      "certificateType" : 0,
      "certificateTypeName" : "string",
      "createDate" : "string",
      "documentNum" : "string",
      "extendField1" : "string",
      "extendField2" : "string",
      "extendField3" : "string",
      "facePicUrl" : "string",
      "humanId" : "string",
      "name" : "string",
      "nation" : "string",
      "nativeCountyCode" : "string",
      "personLibId" : "string",
      "personLibName" : "string",
      "registerAge" : 0,
      "registerGender" : "string",
      "registerGenderName" : "string",
      "reponsibilityPolice" : "string",
      "reponsibilityPoliceAddress" : "string",
      "reponsibilityPoliceNum" : "string",
      "residenceCountyCode" : "string"
    } ],
    "pageNo" : 0,
    "pageSize" : 0,
    "total" : 0
  },
  "msg" : "string",
  "type" : 0
}

展示系统库

POST /customLibrary/listSysLibrary

参数

类型	名称	说明	类型
Body	listLibParams 必填	listLibParams	ListLibParams

响应

HTTP代码	说明	类型
200	OK	BaseResult«List«ListLibSingleResp»»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/customLibrary/listSysLibrary

请求 body

json :
{
  "name" : "string",
  "personLibIds" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : [ {
    "completeProcess" : 0,
    "createName" : "string",
    "createTime" : "string",
    "describe" : "string",
    "editable" : true,
    "extendFieldVOList" : [ {
      "content" : "string",
      "globalType" : 0,
      "id" : 0,
      "labelId" : 0,
      "personLibId" : "string",
      "type" : "string"
    } ],
    "labelIds" : "string",
    "labelVOList" : [ {
      "extendFieldVOList" : [ {
        "content" : "string",
        "globalType" : 0,
        "id" : 0,
        "labelId" : 0,
        "personLibId" : "string",
        "type" : "string"
      } ],
      "id" : 0,
      "name" : "string"
    } ],
    "libType" : "string",
    "personLibId" : "string",
    "personLibName" : "string",
    "share" : 0,
    "shareUsers" : "string",
    "total" : 0
  } ],
  "msg" : "string",
  "type" : 0
}

修改自定义库信息

POST /customLibrary/modifyCustomLibraryInfo

参数

类型	名称	说明	类型
Body	modifyPersonParams 可选	modifyPersonParams	AddPersonParams

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/customLibrary/modifyCustomLibraryInfo

请求 body

json :
{
  "address" : "string",
  "bornTime" : "string",
  "certificateNumber" : "string",
  "certificateType" : "string",
  "documentNum" : "string",
  "extendField1" : "string",
  "extendField2" : "string",
  "extendField3" : "string",
  "humanId" : "string",
  "imageData" : "string",
  "imageUrl" : "string",
  "name" : "string",
  "nation" : "string",
  "nativeCountyCode" : "string",
  "personLibId" : "string",
  "registerGender" : "string",
  "reponsibilityPolice" : "string",
  "reponsibilityPoliceAddress" : "string",
  "reponsibilityPoliceNum" : "string",
  "residenceCountyCode" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

Extend-field-controller

扩展字段

新增扩展字段

POST /extend-field/add

参数

类型	名称	说明	类型
Query	content 可选	内容	string
Query	globalType 可选	1 人脸 2 车辆	integer (int32)
Query	id 可选		integer (int32)
Query	labelId 可选	标签id	integer (int32)
Query	personLibId 可选	名单库id	string
Query	type 可选	GLOBAL全局 LABEL标签 NAMELIST名单库	enum (global, label, namelist)

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/extend-field/add

请求 query

json :
{
  "content" : "string",
  "globalType" : 0,
  "id" : 0,
  "labelId" : 0,
  "personLibId" : "string",
  "type" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

/批量新增

POST /extend-field/batchAdd

参数

类型	名称	说明	类型
Query	fieldVOS 可选	fieldVOS	< 扩展字段 > array(multi)

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/extend-field/batchAdd

请求 query

json :
{
  "fieldVOS" : "[874c5f40b1afe2eba63e1569087d8ad8](#874c5f40b1afe2eba63e1569087d8ad8)"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

/批量新增

POST /extend-field/batchUpdate

参数

类型	名称	说明	类型
Query	fieldVOS 可选	fieldVOS	< 扩展字段 > array(multi)

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/extend-field/batchUpdate

请求 query

json :
{
  "fieldVOS" : "[874c5f40b1afe2eba63e1569087d8ad8](#874c5f40b1afe2eba63e1569087d8ad8)"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

获取列表

GET /extend-field/get

参数

类型	名称	说明	类型
Query	content 可选	内容	string
Query	globalType 可选	1 人脸 2 车辆	integer (int32)
Query	id 可选		integer (int32)
Query	labelId 可选	标签id	integer (int32)
Query	personLibId 可选	名单库id	string
Query	type 可选	GLOBAL全局 LABEL标签 NAMELIST名单库	enum (global, label, namelist)

响应

HTTP代码	说明	类型
200	OK	BaseResult«List«扩展字段»»
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

*/*

HTTP请求示例

请求 path

/extend-field/get

请求 query

json :
{
  "content" : "string",
  "globalType" : 0,
  "id" : 0,
  "labelId" : 0,
  "personLibId" : "string",
  "type" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : [ {
    "content" : "string",
    "globalType" : 0,
    "id" : 0,
    "labelId" : 0,
    "personLibId" : "string",
    "type" : "string"
  } ],
  "msg" : "string",
  "type" : 0
}

更新扩展字段

POST /extend-field/update

参数

类型	名称	说明	类型
Query	content 可选	内容	string
Query	globalType 可选	1 人脸 2 车辆	integer (int32)
Query	id 可选		integer (int32)
Query	labelId 可选	标签id	integer (int32)
Query	personLibId 可选	名单库id	string
Query	type 可选	GLOBAL全局 LABEL标签 NAMELIST名单库	enum (global, label, namelist)

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/extend-field/update

请求 query

json :
{
  "content" : "string",
  "globalType" : 0,
  "id" : 0,
  "labelId" : 0,
  "personLibId" : "string",
  "type" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

Label-controller

标签

新增标签

POST /label/add

参数

类型	名称	说明	类型
Body	labelVO 必填	labelVO	LabelVO

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/label/add

请求 body

json :
{
  "extendFieldVOList" : [ {
    "content" : "string",
    "globalType" : 0,
    "id" : 0,
    "labelId" : 0,
    "personLibId" : "string",
    "type" : "string"
  } ],
  "id" : 0,
  "name" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

批量新增

POST /label/batchAdd

参数

类型	名称	说明	类型
Body	labelVOS 可选	labelVOS	< LabelVO > array

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/label/batchAdd

请求 body

json :
[ {
  "extendFieldVOList" : [ {
    "content" : "string",
    "globalType" : 0,
    "id" : 0,
    "labelId" : 0,
    "personLibId" : "string",
    "type" : "string"
  } ],
  "id" : 0,
  "name" : "string"
} ]

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

批量修改

POST /label/batchUpdate

参数

类型	名称	说明	类型
Body	labelVOS 可选	labelVOS	< LabelVO > array

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/label/batchUpdate

请求 body

json :
[ {
  "extendFieldVOList" : [ {
    "content" : "string",
    "globalType" : 0,
    "id" : 0,
    "labelId" : 0,
    "personLibId" : "string",
    "type" : "string"
  } ],
  "id" : 0,
  "name" : "string"
} ]

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

删除标签

POST /label/delete

参数

类型	名称	说明	类型
Body	id 可选	标签id	integer (int32)

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/label/delete

请求 body

json :
{ }

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

getByType

GET /label/list

响应

HTTP代码	说明	类型
200	OK	BaseResult«List«LabelVO»»
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

*/*

HTTP请求示例

请求 path

/label/list

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : [ {
    "extendFieldVOList" : [ {
      "content" : "string",
      "globalType" : 0,
      "id" : 0,
      "labelId" : 0,
      "personLibId" : "string",
      "type" : "string"
    } ],
    "id" : 0,
    "name" : "string"
  } ],
  "msg" : "string",
  "type" : 0
}

修改标签

POST /label/update

参数

类型	名称	说明	类型
Body	labelVO 可选	labelVO	LabelVO

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/label/update

请求 body

json :
{
  "extendFieldVOList" : [ {
    "content" : "string",
    "globalType" : 0,
    "id" : 0,
    "labelId" : 0,
    "personLibId" : "string",
    "type" : "string"
  } ],
  "id" : 0,
  "name" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

Person-lib-controller

名单库管理首页

新增修改名单库

POST /personLib/addOrUpdatePersonLib

参数

类型	名称	说明	类型
Body	personLibInfo 必填	personLibInfo	ListLibRequest

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/personLib/addOrUpdatePersonLib

请求 body

json :
{
  "describe" : "string",
  "extendFieldVOList" : [ {
    "content" : "string",
    "globalType" : 0,
    "id" : 0,
    "labelId" : 0,
    "personLibId" : "string",
    "type" : "string"
  } ],
  "labelIds" : "string",
  "libType" : 0,
  "personLibId" : "string",
  "personLibName" : "string",
  "share" : 0,
  "shareUsers" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

删除名单库

POST /personLib/deletePersonLib

参数

类型	名称	说明	类型
Body	personLibInfo 可选	personLibInfo	ListLibRequest

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/personLib/deletePersonLib

请求 body

json :
{
  "describe" : "string",
  "extendFieldVOList" : [ {
    "content" : "string",
    "globalType" : 0,
    "id" : 0,
    "labelId" : 0,
    "personLibId" : "string",
    "type" : "string"
  } ],
  "labelIds" : "string",
  "libType" : 0,
  "personLibId" : "string",
  "personLibName" : "string",
  "share" : 0,
  "shareUsers" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

查询名单库列表

POST /personLib/getPersonLibAndTotal

参数

类型	名称	说明	类型
Body	getPersonLibInfo 可选	getPersonLibInfo	GetPersonLibInfo

响应

HTTP代码	说明	类型
200	OK	BaseResult«List«ListLibSingleResp»»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/personLib/getPersonLibAndTotal

请求 body

json :
{
  "name" : "string",
  "type" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : [ {
    "completeProcess" : 0,
    "createName" : "string",
    "createTime" : "string",
    "describe" : "string",
    "editable" : true,
    "extendFieldVOList" : [ {
      "content" : "string",
      "globalType" : 0,
      "id" : 0,
      "labelId" : 0,
      "personLibId" : "string",
      "type" : "string"
    } ],
    "labelIds" : "string",
    "labelVOList" : [ {
      "extendFieldVOList" : [ {
        "content" : "string",
        "globalType" : 0,
        "id" : 0,
        "labelId" : 0,
        "personLibId" : "string",
        "type" : "string"
      } ],
      "id" : 0,
      "name" : "string"
    } ],
    "libType" : "string",
    "personLibId" : "string",
    "personLibName" : "string",
    "share" : 0,
    "shareUsers" : "string",
    "total" : 0
  } ],
  "msg" : "string",
  "type" : 0
}

Super-search-controller

Super Search Controller

analysisImage

GET /superSearch/analysisImage.do

参数

类型	名称	说明	类型
Query	imageUrl 必填	imageUrl	string
Query	targetType 必填	targetType	integer (int32)

响应

HTTP代码	说明	类型
200	OK	BaseResult«object»
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

*/*

HTTP请求示例

请求 path

/superSearch/analysisImage.do

请求 query

json :
{
  "imageUrl" : "string",
  "targetType" : 0
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

queryData

POST /superSearch/queryData.do

参数

类型	名称	说明	类型
Body	superSearchParam 必填	superSearchParam	SuperSearchParam

响应

HTTP代码	说明	类型
200	OK	BaseResult«object»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/superSearch/queryData.do

请求 body

json :
{
  "endTime" : "string",
  "imageRect" : {
    "height" : 0.0,
    "width" : 0.0,
    "x" : 0.0,
    "y" : 0.0
  },
  "imageUrl" : "string",
  "pageNo" : 0,
  "pageSize" : 0,
  "searchKey" : "string",
  "searchType" : 0,
  "startTime" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

uploadImage

POST /superSearch/uploadImage.do

响应

HTTP代码	说明	类型
200	OK	BaseResult«object»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/superSearch/uploadImage.do

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

System-lib-controller

System Lib Controller

getPopulationList

POST /systemLib/getPopulationList

参数

类型	名称	说明	类型
Body	searchCondition 必填	searchCondition	SearchCondition

响应

HTTP代码	说明	类型
200	OK	BaseResult«object»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/systemLib/getPopulationList

请求 body

json :
{
  "TXCard" : "string",
  "idCard" : "string",
  "name" : "string",
  "pageNo" : "string",
  "pageSize" : "string",
  "peopleType" : "string",
  "sex" : "string",
  "txcode" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

transferList

POST /systemLib/transferList

参数

类型	名称	说明	类型
Body	ti 必填	ti	TransferInfo

响应

HTTP代码	说明	类型
200	OK	BaseResult«object»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/systemLib/transferList

请求 body

json :
{
  "list" : [ "object" ],
  "personLibId" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

Vehicle-lib-controller

Vehicle Lib Controller

新增

POST /vehicle-lib/add

参数

类型	名称	说明	类型
Body	vo 必填	vo	VehicleVO

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/vehicle-lib/add

请求 body

json :
{
  "address" : "string",
  "carBrand" : "string",
  "carColor" : "string",
  "carModel" : "string",
  "carType" : "string",
  "extFields" : {
    "string" : "string"
  },
  "id" : "string",
  "idCardNo" : "string",
  "identifyNo" : "string",
  "isFollow" : 0,
  "issueAuth" : "string",
  "libCode" : "string",
  "licenseColor" : "string",
  "licenseNo" : "string",
  "ownerName" : "string",
  "phoneNumber" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

删除车辆

GET /vehicle-lib/delete/libCode/{libCode}

参数

类型	名称	说明	类型
Path	libCode 必填	libCode	string
Body	list 可选	list	< VehicleDelDTO > array

响应

HTTP代码	说明	类型
200	OK	BaseResult
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

*/*

HTTP请求示例

请求 path

/vehicle-lib/delete/libCode/string

请求 body

json :
[ null ]

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

列表

GET /vehicle-lib/page/{pageSize}/{pageNo}

参数

类型	名称	说明	类型
Path	pageNo 必填	pageNo	integer (int32)
Path	pageSize 必填	pageSize	integer (int32)
Query	isFollow 可选		integer (int32)
Query	libCode 可选		string
Query	licenseColor 可选		string
Query	licenseNo 可选		string

响应

HTTP代码	说明	类型
200	OK	BaseResult«BasePage«VehicleVO»»
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

*/*

HTTP请求示例

请求 path

/vehicle-lib/page/0/0

请求 query

json :
{
  "isFollow" : 0,
  "libCode" : "string",
  "licenseColor" : "string",
  "licenseNo" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : {
    "list" : [ {
      "address" : "string",
      "carBrand" : "string",
      "carColor" : "string",
      "carModel" : "string",
      "carType" : "string",
      "extFields" : {
        "string" : "string"
      },
      "id" : "string",
      "idCardNo" : "string",
      "identifyNo" : "string",
      "isFollow" : 0,
      "issueAuth" : "string",
      "libCode" : "string",
      "licenseColor" : "string",
      "licenseNo" : "string",
      "ownerName" : "string",
      "phoneNumber" : "string"
    } ],
    "total" : 0
  },
  "msg" : "string",
  "type" : 0
}

更新

POST /vehicle-lib/update

参数

类型	名称	说明	类型
Body	vo 必填	vo	VehicleVO

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

application/json

生成

*/*

HTTP请求示例

请求 path

/vehicle-lib/update

请求 body

json :
{
  "address" : "string",
  "carBrand" : "string",
  "carColor" : "string",
  "carModel" : "string",
  "carType" : "string",
  "extFields" : {
    "string" : "string"
  },
  "id" : "string",
  "idCardNo" : "string",
  "identifyNo" : "string",
  "isFollow" : 0,
  "issueAuth" : "string",
  "libCode" : "string",
  "licenseColor" : "string",
  "licenseNo" : "string",
  "ownerName" : "string",
  "phoneNumber" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

Web-controller

Web Controller

index

GET /

响应

HTTP代码	说明	类型
200	OK	string
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

*/*

HTTP请求示例

请求 path

HTTP响应示例

响应 200

json :
"string"

index

GET /index

响应

HTTP代码	说明	类型
200	OK	string
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

*/*

HTTP请求示例

请求 path

/index

HTTP响应示例

响应 200

json :
"string"

index

GET /index.do

响应

HTTP代码	说明	类型
200	OK	string
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

*/*

HTTP请求示例

请求 path

/index.do

HTTP响应示例

响应 200

json :
"string"

redirectJJQ

GET /redirectJJQ

响应

HTTP代码	说明	类型
200	OK	string
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

*/*

HTTP请求示例

请求 path

/redirectJJQ

HTTP响应示例

响应 200

json :
"string"

redirectJJQ

GET /redirectJJQ.do

响应

HTTP代码	说明	类型
200	OK	string
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

*/*

HTTP请求示例

请求 path

/redirectJJQ.do

HTTP响应示例

响应 200

json :
"string"

redirectRFID

GET /redirectRFID

响应

HTTP代码	说明	类型
200	OK	string
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

*/*

HTTP请求示例

请求 path

/redirectRFID

HTTP响应示例

响应 200

json :
"string"

redirectRFID

GET /redirectRFID.do

响应

HTTP代码	说明	类型
200	OK	string
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

*/*

HTTP请求示例

请求 path

/redirectRFID.do

HTTP响应示例

响应 200

json :
"string"

定义

AddPersonParams

名称	说明	类型
address 可选	人员住址信息样例 : `"string"`	string
bornTime 可选	出生年月日（格式如2011-06-01）样例 : `"string"`	string
certificateNumber 可选	证件号样例 : `"string"`	string
certificateType 可选	证件类型（111-居民身份证，113-户口簿，114-中国人民解放军军官证，131-工作证，123警官证，133-学生证，335-机动车驾驶证，337-机动车行驶证，414-护照，782-市民卡，990-其他证件）样例 : `"string"`	string
documentNum 可选	档案编号样例 : `"string"`	string
extendField1 可选	扩展字段1 样例 : `"string"`	string
extendField2 可选	扩展字段2 样例 : `"string"`	string
extendField3 可选	扩展字段3 样例 : `"string"`	string
humanId 可选	id 样例 : `"string"`	string
imageData 可选	图片数据通过Base64编码后的字符串（imageUrl与imageData二选一必填,但当两者都存在的时候,默认使用imageUrl。图片像素在256*256-900w内，文件大小在128字节-4M内。图片类型限制为：png、jpg/jpeg、bmp）样例 : `"string"`	string
imageUrl 可选	图片访问地址（imageUrl与imageData二选一必填，但当两者都存在的时候,默认使用imageUrl(Url需要进行encode编码，防止出现特殊字符)。图片像素在256*256-900w内，文件大小在128字节-4M内。图片类型限制为：png、jpg/jpeg、bmp）样例 : `"string"`	string
name 可选	姓名（最大长度32位，只支持中文或英文和.）样例 : `"string"`	string
nation 可选	民族样例 : `"string"`	string
nativeCountyCode 可选	籍贯区县编号样例 : `"string"`	string
personLibId 可选	所属名单库ID（最大长度32）样例 : `"string"`	string
registerGender 可选	注册性别（male-男， female-女，unknown-未知，最大长度为10，默认为unknown）样例 : `"string"`	string
reponsibilityPolice 可选	责任民警样例 : `"string"`	string
reponsibilityPoliceAddress 可选	责任民警地址样例 : `"string"`	string
reponsibilityPoliceNum 可选	责任民警电话样例 : `"string"`	string
residenceCountyCode 可选	居住地区县编号样例 : `"string"`	string

ArtemisApiBasePage«QueryPersonByAttrWithPageResp»

名称	说明	类型
list 可选	样例 : `[ "[querypersonbyattrwithpageresp](#querypersonbyattrwithpageresp)" ]`	< QueryPersonByAttrWithPageResp > array
pageNo 可选	样例 : `0`	integer (int32)
pageSize 可选	样例 : `0`	integer (int32)
total 可选	样例 : `0`	integer (int64)

BasePage«VehicleVO»

名称	说明	类型
list 可选	样例 : `[ "[vehiclevo](#vehiclevo)" ]`	< VehicleVO > array
total 可选	样例 : `0`	integer (int64)

BaseResult

名称	说明	类型
code 可选	样例 : `"string"`	string
data 可选	样例 : `"object"`	object
msg 可选	样例 : `"string"`	string
type 可选	样例 : `0`	integer (int32)

BaseResult«ArtemisApiBasePage«QueryPersonByAttrWithPageResp»»

名称	说明	类型
code 可选	样例 : `"string"`	string
data 可选	样例 : `"[669969a7acb73e4620074bd6b0e6fbc1](#669969a7acb73e4620074bd6b0e6fbc1)"`	ArtemisApiBasePage«QueryPersonByAttrWithPageResp»
msg 可选	样例 : `"string"`	string
type 可选	样例 : `0`	integer (int32)

BaseResult«BasePage«VehicleVO»»

名称	说明	类型
code 可选	样例 : `"string"`	string
data 可选	样例 : `"[361106609fca1f8867debbb702ed6a5e](#361106609fca1f8867debbb702ed6a5e)"`	BasePage«VehicleVO»
msg 可选	样例 : `"string"`	string
type 可选	样例 : `0`	integer (int32)

BaseResult«ImageAnalysisDataResp»

名称	说明	类型
code 可选	样例 : `"string"`	string
data 可选	样例 : `"[imageanalysisdataresp](#imageanalysisdataresp)"`	ImageAnalysisDataResp
msg 可选	样例 : `"string"`	string
type 可选	样例 : `0`	integer (int32)

BaseResult«List«LabelVO»»

名称	说明	类型
code 可选	样例 : `"string"`	string
data 可选	样例 : `[ "[labelvo](#labelvo)" ]`	< LabelVO > array
msg 可选	样例 : `"string"`	string
type 可选	样例 : `0`	integer (int32)

BaseResult«List«ListLibSingleResp»»

名称	说明	类型
code 可选	样例 : `"string"`	string
data 可选	样例 : `[ "[listlibsingleresp](#listlibsingleresp)" ]`	< ListLibSingleResp > array
msg 可选	样例 : `"string"`	string
type 可选	样例 : `0`	integer (int32)

BaseResult«List«扩展字段»»

名称	说明	类型
code 可选	样例 : `"string"`	string
data 可选	样例 : `[ "[874c5f40b1afe2eba63e1569087d8ad8](#874c5f40b1afe2eba63e1569087d8ad8)" ]`	< 扩展字段 > array
msg 可选	样例 : `"string"`	string
type 可选	样例 : `0`	integer (int32)

BaseResult«object»

名称	说明	类型
code 可选	样例 : `"string"`	string
data 可选	样例 : `"object"`	object
msg 可选	样例 : `"string"`	string
type 可选	样例 : `0`	integer (int32)

BaseResult«string»

名称	说明	类型
code 可选	样例 : `"string"`	string
data 可选	样例 : `"string"`	string
msg 可选	样例 : `"string"`	string
type 可选	样例 : `0`	integer (int32)

DelPersonParams

名称	说明	类型
humanId 可选	人员ID 样例 : `"string"`	string
personLibId 可选	名单库标识样例 : `"string"`	string

FaceRect

名称	说明	类型
height 可选	样例 : `0.0`	number (float)
width 可选	样例 : `0.0`	number (float)
x 可选	样例 : `0.0`	number (float)
y 可选	样例 : `0.0`	number (float)

FindDataDictVO

名称	说明	类型
typeCode 可选	样例 : `"string"`	string

GetPersonLibInfo

名称	说明	类型
name 可选	样例 : `"string"`	string
type 可选	样例 : `"string"`	string

ImageAnalysisDataResp

名称	说明	类型
list 可选	样例 : `[ "[imageanalysissingleresp](#imageanalysissingleresp)" ]`	< ImageAnalysisSingleResp > array
total 可选	样例 : `0`	integer (int32)

ImageAnalysisSingleResp

名称	说明	类型
faceImageUrl 可选	样例 : `"string"`	string
faceRect 可选	样例 : `"[facerect](#facerect)"`	FaceRect
modelData 可选	样例 : `"string"`	string
recommendFaceRect 可选	样例 : `"[recommendfacerect](#recommendfacerect)"`	RecommendFaceRect

ImageRect

名称	说明	类型
height 可选	可选, 高度样例 : `0.0`	number (float)
width 可选	可选, 宽度样例 : `0.0`	number (float)
x 可选	可选, X坐标样例 : `0.0`	number (float)
y 可选	可选, Y坐标样例 : `0.0`	number (float)

LabelVO

名称	说明	类型
extendFieldVOList 可选	扩展字段列表样例 : `[ "[874c5f40b1afe2eba63e1569087d8ad8](#874c5f40b1afe2eba63e1569087d8ad8)" ]`	< 扩展字段 > array
id 可选	样例 : `0`	integer (int32)
name 可选	标签名称样例 : `"string"`	string

ListLibParams

名称	说明	类型
name 可选	库名称，api接口无此字段样例 : `"string"`	string
personLibIds 可选	多个中间逗号分隔，不传时返回全部样例 : `"string"`	string

ListLibRequest

名称	说明	类型
describe 可选	名单库描述样例 : `"string"`	string
extendFieldVOList 可选	绑定的扩展字段样例 : `[ "[874c5f40b1afe2eba63e1569087d8ad8](#874c5f40b1afe2eba63e1569087d8ad8)" ]`	< 扩展字段 > array
labelIds 可选	绑定标签的id，用,隔开样例 : `"string"`	string
libType 可选	名单库类型，0-人脸名单库，1-车辆名单库样例 : `0`	integer (int32)
personLibId 必填	名单库ID 样例 : `"string"`	string
personLibName 必填	名单库名称样例 : `"string"`	string
share 可选	0不共享 1部分共享 2公开样例 : `0`	integer (int32)
shareUsers 可选	共享的人名单用,隔开样例 : `"string"`	string

ListLibSingleResp

名称	说明	类型
completeProcess 可选	补全进度样例 : `0`	integer (int32)
createName 可选	创建人姓名样例 : `"string"`	string
createTime 可选	创建时间样例 : `"string"`	string
describe 可选	名单库描述样例 : `"string"`	string
editable 可选	是否可编辑样例 : `true`	boolean
extendFieldVOList 可选	绑定的扩展字段样例 : `[ "[874c5f40b1afe2eba63e1569087d8ad8](#874c5f40b1afe2eba63e1569087d8ad8)" ]`	< 扩展字段 > array
labelIds 可选	绑定标签的id，用,隔开样例 : `"string"`	string
labelVOList 可选	标签列表样例 : `[ "[labelvo](#labelvo)" ]`	< LabelVO > array
libType 可选	名单库类型 base基本类型 important重要样例 : `"string"`	string
personLibId 必填	名单库ID 样例 : `"string"`	string
personLibName 必填	名单库名称样例 : `"string"`	string
share 可选	0不共享 1部分共享 2公开样例 : `0`	integer (int32)
shareUsers 可选	共享的人名单用,隔开样例 : `"string"`	string
total 可选	总数样例 : `0`	integer (int32)

QueryPersonByAttrWithPageResp

名称	说明	类型
bornTime 可选	出生年月日（格式如2011-06-01）样例 : `"string"`	string
certificateNumber 可选	证件号样例 : `"string"`	string
certificateType 可选	证件类型（111-居民身份证，113-户口簿，114-中国人民解放军军官证，131-工作证，123警官证，133-学生证，335-机动车驾驶证,337-机动车行驶证，414-护照，782-市名卡，990-其他证件。取值参考【数据字典】，typeCode为common.human_certificate_type）样例 : `0`	integer (int32)
certificateTypeName 可选	证件类型说明样例 : `"string"`	string
createDate 可选	入库时间（IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz）样例 : `"string"`	string
documentNum 可选	档案编号样例 : `"string"`	string
extendField1 可选	扩展字段1 样例 : `"string"`	string
extendField2 可选	扩展字段2 样例 : `"string"`	string
extendField3 可选	扩展字段3 样例 : `"string"`	string
facePicUrl 可选	人脸URL，该字段具体使用方式参考【图片访问方式说明】样例 : `"string"`	string
humanId 可选	人员名单id 样例 : `"string"`	string
name 可选	人员姓名（最大长度32位，只支持中文或英文和.）样例 : `"string"`	string
nation 可选	民族样例 : `"string"`	string
nativeCountyCode 可选	籍贯区县编号样例 : `"string"`	string
personLibId 可选	名单库ID(最大长度32) 样例 : `"string"`	string
personLibName 可选	名单库名称（最大长度32，只支持中文、英文、数字、_、- ）样例 : `"string"`	string
registerAge 可选	人员年龄样例 : `0`	integer (int32)
registerGender 可选	注册性别 male-男, female-女,unknown-未知。最大长度为10 样例 : `"string"`	string
registerGenderName 可选	注册性别说明样例 : `"string"`	string
reponsibilityPolice 可选	责任民警样例 : `"string"`	string
reponsibilityPoliceAddress 可选	责任民警地址样例 : `"string"`	string
reponsibilityPoliceNum 可选	责任民警电话样例 : `"string"`	string
residenceCountyCode 可选	居住地区县编号样例 : `"string"`	string

RecommendFaceRect

名称	说明	类型
height 可选	可选, 高度样例 : `0.0`	number (float)
width 可选	可选, 宽度样例 : `0.0`	number (float)
x 可选	可选, X坐标样例 : `0.0`	number (float)
y 可选	可选, Y坐标样例 : `0.0`	number (float)

SearchCondition

名称	说明	类型
TXCard 可选	样例 : `"string"`	string
idCard 可选	样例 : `"string"`	string
name 可选	样例 : `"string"`	string
pageNo 可选	样例 : `"string"`	string
pageSize 可选	样例 : `"string"`	string
peopleType 可选	样例 : `"string"`	string
sex 可选	样例 : `"string"`	string
txcode 可选	样例 : `"string"`	string

SuperSearchParam

名称	说明	类型
endTime 可选	样例 : `"string"`	string
imageRect 可选	样例 : `"[imagerect](#imagerect)"`	ImageRect
imageUrl 可选	样例 : `"string"`	string
pageNo 可选	样例 : `0`	integer (int32)
pageSize 可选	样例 : `0`	integer (int32)
searchKey 可选	样例 : `"string"`	string
searchType 可选	样例 : `0`	integer (int32)
startTime 可选	样例 : `"string"`	string

TransferInfo

名称	说明	类型
list 可选	样例 : `[ "object" ]`	< object > array
personLibId 可选	样例 : `"string"`	string

VehicleVO

名称	说明	类型
address 可选	车主地址样例 : `"string"`	string
carBrand 可选	车辆品牌样例 : `"string"`	string
carColor 可选	车辆颜色样例 : `"string"`	string
carModel 可选	样例 : `"string"`	string
carType 可选	车辆型号样例 : `"string"`	string
extFields 可选	其它字段样例 : `{<br> "string" : "string"<br>}`	< string, string > map
id 可选	id 样例 : `"string"`	string
idCardNo 可选	车主身份证号样例 : `"string"`	string
identifyNo 可选	代号识别样例 : `"string"`	string
isFollow 可选	是否关注 0 不关注 1 关注样例 : `0`	integer (int32)
issueAuth 可选	发证机关样例 : `"string"`	string
libCode 可选	名单库样例 : `"string"`	string
licenseColor 可选	车牌号颜色样例 : `"string"`	string
licenseNo 可选	车牌号样例 : `"string"`	string
ownerName 可选	车主姓名样例 : `"string"`	string
phoneNumber 可选	车主联系方式样例 : `"string"`	string

名单库查询参数

名称	说明	类型
beginTime 可选	入库开始时间（IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 样例 : `"string"`	string
certificateNumber 可选	证件号样例 : `"string"`	string
certificateType 可选	证件类型(111-居民身份证,113-户口簿,114-中国人民解放军军官证,131-工作证,123警官证,133-学生证,335-机动车驾驶证,337-机动车行驶证,414-护照,782-市民卡,990-其他证件) 样例 : `"string"`	string
endTime 可选	入库结束时间（IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz）样例 : `"string"`	string
humanIds 可选	人员名单唯一标识(“-1”为查询所有记录，多个使用”,”分割) 样例 : `"string"`	string
name 可选	注册性别(male-男, female-女,unknown-未知。最大长度为10）样例 : `"string"`	string
nativeCountyCode 可选	籍贯区县编号(支持模糊查询，后缀带%) 样例 : `"string"`	string
pageNo 可选	指定第几页，从1开始样例 : `0`	integer (int32)
pageSize 可选	每页返回条数样例 : `0`	integer (int32)
personLibId 可选	人脸名单库ID（最大长度32）样例 : `"string"`	string
registerGender 可选	样例 : `"string"`	string
residenceCountyCode 可选	居住地区县编号(支持模糊查询，后缀带%) 样例 : `"string"`	string

图片分析

名称	说明	类型
imageData 可选	图片内容样例 : `"string"`	string
imageUrl 可选	图片url 样例 : `"string"`	string
returnAttributes 可选	样例 : `true`	boolean

扩展字段

名称	说明	类型
content 可选	内容样例 : `"string"`	string
globalType 可选	1 人脸 2 车辆样例 : `0`	integer (int32)
id 可选	样例 : `0`	integer (int32)
labelId 可选	标签id 样例 : `0`	integer (int32)
personLibId 可选	名单库id 样例 : `"string"`	string
type 可选	GLOBAL全局 LABEL标签 NAMELIST名单库样例 : `"string"`	enum (global, label, namelist)

jiekou

使用swagger2构建短视频后端api接口文档

概览

版本信息

联系方式

URI scheme

标签

资源

Common-controller

findDataDict

参数

响应

消耗

生成

HTTP请求示例

请求 path

请求 body

HTTP响应示例

响应 200

getImageStream

响应

生成

HTTP请求示例

请求 path

上传人脸图片

响应

消耗

生成

HTTP请求示例

请求 path

HTTP响应示例

响应 200

Custom-library-controller

新增自定义库信息(单个新增)

参数

响应

消耗

生成

HTTP请求示例

请求 path

请求 body

HTTP响应示例

响应 200

信息补全

参数

响应

消耗

生成

HTTP请求示例

请求 path

请求 body

HTTP响应示例

响应 200

删除名单库人员

参数

响应

消耗

生成

HTTP请求示例

请求 path

请求 body

HTTP响应示例

响应 200

downloadCustomTemplate

响应

消耗

生成

HTTP请求示例

请求 path

HTTP响应示例

响应 200

分析人脸图片

参数

响应

消耗

生成

HTTP请求示例

请求 path

请求 body

HTTP响应示例