快速入门

概述

本节主要介绍如何调用创建API接口创建一个HTTP类型的API。

API的调用方法请参见如何调用API。

创建流程

1. 调用创建API分组接口，创建一个API分组。
2. 调用创建API接口，创建一个HTTP类型API。

创建一个HTTP类型的API

1. 调用创建API分组接口，创建一个API分组。

   {
   	"name": "APIGroup_test",
   	"remark": "测试分组"
   }

   您需要指定如下参数：

   • name：API分组的名称
   • remark：对于此API分组的描述信息

2. 调用创建API接口，创建一个HTTP类型API。

   {
   	"auth_type": "APP",
   	"backend_api": {
   		"req_method": "GET",
   		"req_protocol": "HTTP",
   		"req_uri": "/test/benchmark",
   		"timeout": 1000,
   		"url_domain": "xx.xx.xx.93:12346"
   	},
   	"backend_type": "HTTP",
   	"group_id": "2b89e73458******98a828c5eca3b6c3",
   	"name": "test",
   	"req_method": "GET",
   	"req_uri": "/test",
   	"type": 1,
   	"result_normal_sample": "hello world!"
   }

   您需要指定如下参数：

   • auth_type：API认证方式
   • backend_api：后端服务的参数
     • req_method：接口调用方式
     • req_protocol：后端服务的请求协议
     • req_uri：后端服务的请求路径
     • timeout：API网关请求后端服务的超时时间
     • url_domain：后端服务的地址
       

       不可使用如下预留地址段：

       • 0.0.0.0/8
       • 10.0.0.0/8
       • 100.125.0.0/16
       • 127.0.0.0/8
       • 169.254.0.0/16
       • 172.16.0.0/12
       • 192.0.0.0/24
       • 192.0.2.0/24
       • 192.88.99.0/24
       • 192.168.0.0/16
       • 198.18.0.0/15
       • 198.51.100.0/24
       • 203.0.113.0/24
       • 224.0.0.0/4
       • 240.0.0.0/4
       • 255.255.255.255/32
   • backend_type：后端服务的类型
   • group_id：API所属的分组编号，获取方式请参见查询分组列表
   • name：API的名称
   • req_method：API的请求方式
   • req_uri：API的访问地址
   • type：API类型，1表示公有API，2表示私有API
   • result_normal_sample：正常响应示例，描述API的正常返回信息

   API创建完后，您可以在API网关的管理控制台查看到该API。