基本属性配置

填写基本属性。包含API分组、名称、路径、请求方式、请求协议、返回类型等信息。

API基本属性_向导

基本信息

  • 所属类目:API的分类地址,用户可在“API管理”的“类目管理”中查看当前的分组类目;

  • API名称:只能以字母,数字,下划线组成,不支持中文;

  • API中文名称:可以使用中文对API进行描述,便于查找;

  • API标签:便于在API申请时利用标签更快速地找到所需申请的API。
    标签使用步骤 单击输入框,数栈展示当前已生成的标签,用户可选择已有标签或在输入框输入内容搜索匹配,若没有所需标签,用户可在输入框中直接输入所需标签,按回车键后系统自动生成单个标签;

若填写API path,API测试URL(用于第三方工具测试,测试无误后可发布API至生产环境)中将包含 API path,不影响正式调用API的URL。
API测试URL:…​/api/gateway/{项目英文名称}/{API path}/{API名称}
API正式调用URL:…​/api/gateway/{项目英文名称}/{API名称}

API参数

  • 协议:HTTP/HTTPS;

  • 请求方式:GET、POST;

  • 返回类型:JSON;

  • 超时时间:配置请求的超时响应时间,在API实际调用和在线测试环节都会进行超时时间的限制,超时时间默认3秒,用户可选择1-30秒钟之间的整数进行填写;

安全与限制策略

  • 单用户单秒调用次数上限:限制单用户每秒对API的调用次数的上限,默认是2000;

  • 安全组:安全组用于限制访问API的黑白名单,保障API访问的安全性。每个安全组是一组IP地址,用于限制某API在这些IP范围内调用或禁止调用,如果用户未建立任何安全组,可进入安全组进行新建,安全组修改后立即生效;

当安全组配置重合,白名单与黑名单冲突时,数栈以黑名单为准,若需冲突IP能够正常使用,将黑名单中的冲突IP去除即可。