文档

创建API并添加接口

更新时间:

云原生API网关支持通过控制台和从文件表单两种方式创建API并添加API接口。

操作步骤

说明

仅支持添加/导入HTTP API。

通过控制台创建

创建API

  1. 登录云原生API网关控制台

  2. 在左侧导航栏,选择API管理 > API列表,并在顶部菜单栏选择地域。

  3. 在页面左上角,单击创建API > HTTP(s)

  4. 创建HTTP API面板中,配置API相关参数,并单击确定

    配置项

    说明

    API名称

    自定义创建的API名称。

    重要

    API名称必须全局唯一。

    协议

    支持HTTPHTTPS

    Base Path

    API的基本路径,访问具体接口时,完整路径为http(s)://{域名}/{apiBasePath}/{接口Path}

    版本管理

    是否启用API版本管理能力,不同版本的API视为独立的API,它们具有相同的API名称,但API的其他基本信息和接口信息可以不同。访问时需要指定版本标识符。

    开启版本管理功能后,需要配置版本号使用方式

    说明
    • 选择使用方式Query时,需要配置参数项添加Query

    • 选择使用方式Header时,需要配置参数项添加Header

    版本号

    相同API名称下,以版本号进行区分。

    使用方式

    支持PathQueryHeader三种方式。

    • 使用Path时,需要完整访问路径为:/API基本路径/版本号/接口路径。

    • 使用Query时,完整访问路径为:/API基本路径/接口路径,请求参数中需要配置参数项添加Query为版本号。

    • 使用Header时,完整访问路径为:/API基本路径/接口路径,请求头中需要配置参数项添加Header为版本号。

    描述

    填写API的相关描述。

添加API接口

  1. 登录云原生API网关控制台

  2. 在左侧导航栏,选择API管理 > API列表,并在顶部菜单栏选择地域。

  3. 选择目标API及对应的版本后,单击添加接口image

  4. 创建接口面板中,配置接口相关参数,并单击创建

    配置项

    说明

    接口名称

    自定义创建的接口名称,在API下需要全局唯一。

    接口Path

    接口的具体路径。

    Method

    接口的请求方法。接口的路径+接口的方法,需要在API下全局唯一。

    描述

    接口的描述信息。

    请求定义

    支持定义HeaderQueryParameter Path参数以及Body参数。

    其中Path参数支持在接口Path中三种定义变量的方式:

    • /books/[bookId]

    • /books/{bookId}

    • /books/:bookId

    其中,推荐使用{bookId}方式进行定义。

    请求定义仅用于生成SDK和文档,不对运行时进行校验。

    响应定义

    定义不同响应码的数据结构。

    响应码定义仅用于生成SDK和文档,不对运行时进行校验。

    Mock

    Mock配置仅在API发布Mock场景下生效。

从标准OAS文件导入

  1. 登录云原生API网关控制台

  2. 在左侧导航栏,选择API管理 > API列表,并在顶部菜单栏选择地域。

  3. 在页面左上角,单击创建API > 基于OpenAPI文件创建

  4. 基于OpenAPI创建文件面板中,配置API相关参数,并单击确定

    配置项

    说明

    API名称

    自定义创建的API名称,API名称需要全局唯一。

    OpenAPI文件

    支持选择文件或粘贴文本内容。

    版本管理

    是否启用API版本管理能力,不同版本的API视为独立的API,它们具有相同的API名称,但API的其他基本信息和接口信息可以不同。访问时需要指定版本标识符。

    开启版本管理功能后,需要配置版本号使用方式

    说明
    • 选择使用方式Query时,需要配置参数项添加Query

    • 选择使用方式Header时,需要配置参数项添加Header

    版本号

    相同API名称下,以版本号进行区分。

    使用方式

    支持PathQueryHeader三种方式。

    • 使用Path时,需要完整访问路径为:/API基本路径/版本号/接口路径。

    • 使用Query时,完整访问路径为:/API基本路径/接口路径,请求参数中需要配置参数项添加Query为版本号。

    • 使用Header时,完整访问路径为:/API基本路径/接口路径,请求头中需要配置参数项添加Header为版本号。

    描述

    填写API的相关描述。