一、產品介紹
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的請求方式}¶mArr=${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¶mArr=${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¶mArr=%5B%22name%3Dlisi%22%2C%20%22age%3D20%22%5D&contentType=json&ColaKey=xsnjxnshxsh';四、注意點
您的ColaKey參數必須有效,否則無法正常使用!
注意!!!: 如果您還沒有ColaKey,請先請前往luckycola官網[個人中心]獲取
luckycola官網地址:http(s): //luckycola.com.cn/
