tencent cloud

文档反馈

导入 API

最后更新时间:2023-12-22 09:48:27

    操作场景

    该任务指导您在 API 网关控制台通过导入 OpenAPI 来创建 API。

    前提条件

    已完成 服务创建
    准备 OpenAPI 3.0.0 标准的 API 描述文件,文本格式为 YAML 或 JSON。

    操作步骤

    1. 登录 API 网关控制台,在左侧导航栏单击服务
    2. 在服务列表中,单击目标服务的服务名,查看该服务。
    3. 在服务信息中,单击管理 API 标签页,查看该服务下的 API 列表。
    4. 单击 API 列表上方的导入 API,进入导入 API 页面。
    5. 选择文本格式(YAML 或 JSON),并单击上传文件,选择要上传的 API 描述文件;或者直接在代码编辑器中输入描述 API 的内容。
    6. 单击保存,API 网关将根据您输入的内容创建 API,并在创建完成后返回本次创建成功的 API 列表。
    
    
    

    注意事项

    导入 API 支持 OpenAPI 3.0.0 标准的 API 定义,支持 YAML 和 JSON 格式的描述文件。
    单次不能同时导入超过10个API。
    上传 API 描述文件时,文件后缀名必须为 .yaml 或 .json;单次上传的 API 描述文件不能超过 100KB;上传的描述文件会覆盖代码编辑器里的内容。
    创建成功的 API 将不会自动发布,需要您手动发布后方可生效。
    从标准 OpenAPI3.0 描述文件导入 API,需要手动添加 servers 字段,用来定义 API 访问的后端地址,例如:
    servers:
    - url: 'http://localhost:8080'
    description: Generated server url
    
    说明:
    OpenAPI 规范和 API 网关的映射关系请参见 定义 API
    导入 API 的完整示例请参见 导入 API 示例
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持