智能API代码示例生成工具AiRestful

一、产品介绍

AiRestful是一款基于智能AI的,帮助小白快速生成任意编程语言的API接口调用示例代码的编程工具.它的特点是:简单易用、集成支持、多主流编程语言覆盖.它是面向学生、编程爱好者、编程小白的实用工具.

AiRestful官网: 点击直达AiRestful官网

二、如何使用

AiRestful是简单易用的,只需要三步即可为您生成您需要的编程语言的代码示例.

1、第一步(必须):

根据您的接口文档要求, 完成:

• 请求方式设置: 默认值是 GET
• API接口填写
• 参数传入格式设置: 默认值是 application/json

2、第二步(可选):

根据您的接口文档要求, 完成请求参数或header的添加设置:
(如果您的接口不需要这些参数就可以不添加)

3、第三步(智能生成):

您完成前面两步的相关参数设置和添加后,
就可以在第三步中,选择您需要生成代码的“编程语言“,完成编程语言选择后,点击“立即生成“按钮等待智能生成结果即可.

AiRestful不仅仅可以帮您生成您需要的编程语言的代码示例,它还可以给您详细的代码使用解释,帮助您使用和理解.

三、如何集成到您的网站(应用)

1、开始接入

AiRestful是支持接入到您的网站或者应用的,您只需要在您的应用中提供一个“入口“,带上您的api参数跳转至AiRestful即可,
您需要配置的跳转url格式参数如下:

let aiRestfulUrl = `https://luckycola.com.cn/public/dist/#/aiRestful/aiRestfulApi?api=${encodeURIComponent('你自定义的api地址')}&method=${您API的请求方式}&paramArr=${encodeURIComponent('["param1=value1", "param2=value2"]')}&headerArr=${encodeURIComponent('["header1=value1"]')}&contentType=${您API的请求参数格式}&ColaKey=${您的ColaKey}`;

以上参数说明:

序号	参数	是否必须	说明
1	api	是	您的自定义API,这个是必须传入的, 且需要进行encodeURIComponent处理
2	ColaKey	否	您的ColaKey,是一个合法性校验值,建议传入, 如果不传入用户将需要登录,传入后就可以不登录直接使用“AI生成“
3	method	否	您的自定义API的请求方式,可以传入值是: get、post、put、delete、options、patch
4	paramArr	否	您的自定义API的请求参数,是数组格式,且需要进行encodeURIComponent处理
5	headerArr	否	您的自定义API的header参数,是数组格式,且需要进行encodeURIComponent处理
6	contentType	否	您的自定义API的请求参数格式,可以传入值是: json、xml、x-www-form-urlencoded、plain、html

2、接入案例

我现在要为自定义的API(http://testapi/v1)配置AiRestful功能,该自定义API是post请求的,参数有两个.分别是name=lisi、age=20,请求参数格式是json格式,那么就需要这样配置跳转链接:

// 这个是原代码,请注意api、headerArr、paramArr参数是需要encodeURIComponent的,否则会乱码
let aiRestfulUrl = `https://luckycola.com.cn/public/dist/#/aiRestful/aiRestfulApi?api=${encodeURIComponent('http://testapi/v1')}&method=post&paramArr=${encodeURIComponent('["name=lisi", "age=20"]')}&contentType=json&ColaKey=xsnjxnshxsh`;

注意: api、headerArr、paramArr参数是需要encodeURIComponent的,否则会乱码!
注意: api、headerArr、paramArr参数是需要encodeURIComponent的,否则会乱码!
注意: api、headerArr、paramArr参数是需要encodeURIComponent的,否则会乱码!

// 这个是完成encodeURIComponent后的url
let aiRestfulUrl = 'https://luckycola.com.cn/public/dist/#/aiRestful/aiRestfulApi?api=http%3A%2F%2Ftestapi%2Fv1&method=post&paramArr=%5B%22name%3Dlisi%22%2C%20%22age%3D20%22%5D&contentType=json&ColaKey=xsnjxnshxsh';

四、注意点

您的ColaKey参数必须有效,否则无法正常使用!

注意!!!: 如果您还没有ColaKey,请先请前往luckycola官网[个人中心]获取
luckycola官网地址:http(s): //luckycola.com.cn/