HOS基础开发平台

# API管理

# 1. 概述

API管理，用于管理API信息，主要提供给开发人员使用。

API管理主要功能包含 查询、新增、编辑、 删除、导出PDF、 数据日志参考、 数据生命周期参考、 导入参考、 导出参考。

【菜单路径：】 开发集成 --> OpenAPI --> API管理

menu_01.png

# 2. 查询OpenAPI

在查询页面可以通过 编码、名称、接口类别 筛选OpenAPI数据

search_01.png

# 3. 新增OpenAPI

点击【新增】按钮，打开新增页面，如下图所示：

add_01.png

# 3.1 基本信息

属性名 属性说明
编码 编码，唯一不可重复，必填项
名称 名称，必填项
请求方式 POST/GET/DELETE/PUT
接口地址 接口的调用地址
接口状态 接口的状态：内测/发布/维护/禁止。
内测状态代表该接口正处于内部测试阶段，不提供给外部使用。
发布状态代表接口正常使用。
维护状态代表接口仍正常使用，但版本过期，且后期可能会停用。
禁止状态代表接口已经被停用
最大调用频率（次/分钟） 每分钟最大调用次数，若不设置代表不控制。
接口类别 数据来源于业务字典，区分接口类别
鉴权方式 接口的鉴权方式，目前支持两种：无、鉴权。
无代表为开放型接口，其他人均可以调用。
鉴权代表授权后的应用才可以使用，接口的授权请看 api授权
备注 备注信息

# 3.2 结构信息

结构信息中包含 请求头、 Query参数、 请求体、 URL映射参数、 返回信息 五部分功能

# 3.2.1 请求头

  • 功能：维护接口请求头（Request Headers）中的参数信息
  • 页面如下：

add_02.png

  • 字段描述
列名 属性说明
参数字段 参数名称，英文名称
参数值 参数的示例值
说明 参数说明
操作 操作按钮，从左向右依次为 新增（在该条目的下面新增一条）、
上移、下移、删除
  • 示例
http://10.1.20.12:8367/api/getmsg

Request Headers:
    token:IDLIOGE900IDOE909

例如：

add_09.png

# 3.2.2 Query参数

  • 功能：维护接口Query参数中的参数信息，即放到请求后的参数， 例如 http://xxx?name=aaa地址中name参数

  • 页面如下：

add_03.png

  • 各列含义描述
列名 属性说明
参数字段 参数名称，英文名称
必填 是否为必填项
字段类型 该参数的类型，请参考下方 字段类型说明
字段名称 参数中文名称
示例 参数示例值
操作 操作按钮，从左向右依次为 新增（在该条目的下面新增一条）、
上移、下移、删除
  • 字段类型说明
类型名称 说明
int 整数类型，例如10，100等
Float 单精度浮点类型，例如2.2，2.3等
String 字符类型，例如 “张三”、“名称”等
Long 长整数类型，例如 2247483147等
Double 双精度浮点类型
Boolean 布尔类型，true和false
Date 日期类型,例如 2022-01-01
Object 对象类型，对应JSON类型中键值对：{}。例如，存在子节点name,则其代表的格式为 { "name":? }
Array 数组类型，对应JSON类型中数组：[{}]。例如，存在子节点name,则其代表的格式为 [{ "name":? }]
  • 示例
http://10.1.20.12:8367/api/getmsg？code=ceshi001&name=测试人员

例如：

add_10.png

# 3.2.3 请求体

  • 功能：维护接口请求体的参数信息，即RequestBody
  • 页面如下：

add_04.png

  • 各列含义描述
列名 属性说明
参数字段 参数名称，英文名称
必填 是否为必填项
字段类型 该参数的类型，请参考字段类型说明
字段名称 参数中文名称
示例 参数示例值
操作 操作按钮，从左向右依次为 新增（在该条目的下面新增一条）
、添加子节点、上移、下移、删除
  • 导入

点击【导入】按钮，在弹出层中填写JSON后，单击【保存】按钮，如图所示

add_04.png

其后会根据输入的JSON自动生成相关配置，其结果如下：

add_04.png

其后使用者需根据具体情况继续完善相关配置

  • 示例
http://10.1.20.12:8367/api/getmsg

RequestBody:
{
    "name":"调用次数",
    "value":2001
}

例如：

add_11.png


提示

root节点默认根节点，若选择类型为Object,代表请求体中JSON格式为键值对， 例如，{"name":"张三","sex":"男",...}。
若选择类型为Array,代表请求体中JSON格式为数组类型， 例如，[{"name":"张三","sex":"男",...},{"name":"李四","sex":"男",...},...]。
以此类推

# 3.2.4 URL映射参数

  • 功能：维护接口URL映射参数中的参数信息
  • 页面如下：

add_05.png

  • 各列含义描述
列名 属性说明
参数字段 参数名称，英文名称
必填 是否为必填项
字段类型 该参数的类型，请参考字段类型说明
字段名称 参数中文名称
示例 参数示例值
操作 操作按钮，从左向右依次为 新增（在该条目的下面新增一条）
、上移、下移、删除
  • 示例
http://10.1.20.12:8367/api/getmsgById/10001

例如：

add_12.png

后端Java代码为：

@GetMapping("/getmsgById/{id}")
public BaseResponse getmsgById(@PathVariable("id") String id) {
    return BaseResponse.success(id);
}

该处维护的地址为 http://10.1.20.12:8367/api/getmsgById/{id}。 对应到示例请求中，表示id值为10001

# 3.2.5 返回信息

  • 功能：维护接口返回信息中参数信息
  • 页面如下：

add_05.png

  • 各列含义描述
列名 属性说明
参数字段 参数名称，英文名称
必填 是否为必填项
字段类型 该参数的类型，请参考字段类型说明
字段名称 参数中文名称
示例 参数示例值
操作 操作按钮，从左向右依次为 新增（在该条目的下面新增一条）
、添加子节点、上移、下移、删除
  • 导入

请参考请求体-导入功能说明

  • 示例

对应图中示例

add_05.png

则返回数据示例为

{
  "code":"200",
  "msg":"",
  "data":[
    {
      "name": "调用次数",
      "value": 26300
    }
  ]
}

提示

root节点默认根节点，若选择类型为Object,代表请求体中JSON格式为键值对， 例如，{"code":"200","msg":"","data":[],...}。
若选择类型为Array,代表请求体中JSON格式为数组类型， 例如，[{"name":"张三","sex":"男",...},{"name":"李四","sex":"男",...},...]。
以此类推

# 4. 编辑OpenAPI

点击具体记录后的编辑按钮，打开数据编辑页面

edit_01.png

# 5. 删除OpenAPI

删除功能分为单条记录删除和批量删除，下面分别介绍

  • 单条记录删除

点击具体记录后的【删除】按钮，并在弹出框中点击【确认】，便可完成对单条记录的删除操作

delete_01.png

  • 批量删除

勾选需要删除的记录，点击【删除】按钮，并在弹出框中点击【确认】，完成批量删除

delete_02.png

# 6. 导出PDF

点击【导出pdf】导出所有的接口信息的pdf。

pdf_01.png

← API授权 →