မင်္ဂလာပါ။
ကျွန်တော်ကတော့ Spiceworks Myanmar မှာ Backend Developer အနေနဲ့ တာဝန်ယူလုပ်ကိုင်နေတဲ့ သုတယာမိုး ဖြစ်ပါတယ်။ ဒီတစ်ခေါက်မှာတော့ API တစ်ခု create လုပ်ပြီး RapidAPI ပေါ်ဘယ်လို တင်ရမလဲဆိုတာကို ဝေမျှပေးသွားမှာဖြစ်ပါတယ်။ RapidAPI ဆိုတာကတော့ API တွေကို အရောင်းအဝယ်လုပ်နိုင်တဲ့ API Marketplace တစ်ခုဖြစ်ပါတယ်။ ကျွန်တော်ကတော့ Laravel ကိုအသုံးပြုပြီး string တွေကို QR code အနေနဲ့ ပြောင်းပေးတဲ့ API တစ်ခုကို create လုပ်သွားမှာဖြစ်ပါတယ်။
ပထမဆုံးအနေနဲ့ Laravel နဲ့ QR Code Plugin တစ်ခုကို အောက်ပါ command များကို အသုံးပြုကာ install လုပ်ပေးရမှာဖြစ်ပါတယ်။

composer create-project laravel/laravel project_name
composer require simplesoftwareio/simple-qrcode “~4”

Laravel မှာ api route တွေကို routes/api.php မှာ ရေးပေးရမှာ ဖြစ်ပါတယ်။

Fig.(1) က code ရဲ့ ဆိုလိုရင်းကတော့ https://domain.com/api/qr-code?url=https://example.com ဆိုတဲ့ api url တစ်ခုရှိတယ်ဆိုပါစို့။ ထို api url မှာ ပါလာတဲ့ query parameter ဖြစ်တဲ့ url ရဲ့ value ကို QR code အနေနဲ့ ပြောင်းလဲပေးမှာဖြစ်ပါတယ်။ အကျဉ်းအားဖြင့် https://example.com ကို QR code အနေနဲ့ ပြောင်းလဲပေးတာဖြစ်ပါတယ်။

API create လုပ်ပြီးသွားပြီဖြစ်တဲ့အတွက် ထို API ကို RapidAPI ပေါ် တင်ဖို့အတွက် အဆင့်ဆင့်လုပ်ဆောင်ပုံတွေကို ဆက်လက်ပြီး ပုံနှင့်တကွ ဖော်ပြပေးမှာဖြစ်ပါတယ်။ Fig.(3) မှာဖော်ပြထားတဲ့အတိုင်း https://rapidapi.com/studio url သို့သွားပေးပါ။ ထို့နောက် “+ Add API project” button ကိုနှိပ်ပါက modal box တစ်ခုပေါ်လာပါမယ်။ ထို modal box တွင် မိမိ တင်မည့် API ရဲ့ နာမည်၊ အကျဉ်းချုပ်၊ အမျိုးအစား အစရှိတာတွေကို ဖြည့်သွင်းပြီး create လုပ်ပါ။

create လုပ်ပြီးပါက Fig.(4) မှာဖော်ပြထားသည့်အတိုင်း Hub Listing သို့ဝင်ပါက General ဆိုတဲ့ tab အတွင်းသို့ ရောက်ရှိမှာဖြစ်ပါတယ်။ ထိုနေရာမှာကတော့ မိမိ API ရဲ့ ပုံ၊ အကျဉ်းချုပ်၊ မိမိ API ကိုတင်ထားတဲ့ server ရဲ့ website url အစရှိတာတွေကို ဖြည့်ပေးရမှာ ဖြစ်ပါတယ်။

Fig.(5) ရဲ့ Endpoints Tab မှာကတော့ မိမိ API Endpoints တွေကို create လုပ်ပေးရမယ့် နေရာဖြစ်ပါတယ်။ Endpoints create လုပ်ရန် create endpoint ကိုနှိပ်ပေးပါ။ ထို့နောက် Endpoint ရဲ့name, description, external doc url, exteranl doc description တို့ကို ဖြည့်ပေးရမှာ ဖြစ်ပါတယ်။ External Doc Url ကတော့ endpoint အကြောင်းကို အကျယ်တဝင့်ရှင်းပြထားတဲ့ website url ရှိရင် ထည့်ပေးရမယ့်နေရာ ဖြစ်ပါတယ်။ External Doc Description ကတော့ ထို endpoint အကြောင်းကို အကျယ်တဝင့်ရှင်းပြထားတဲ့ အကြောင်းအရာကို ဖြည့်ပေးရမယ့်နေရာ ဖြစ်ပါတယ်။

Fig.(6) မှာဖော်ပြထားတဲ့ methods မှာကတော့ GET, POST, PUT, PATCH, DELETE အစရှိတဲ့ methods တွေထဲက မိမိတင်မယ့် api endpoint နဲ့ သက်ဆိုင်တဲ့ method ကိုရွေးပေးရမှာဖြစ်ပါတယ်။ Endpoint ကတော့ မိမိ api ရဲ့ endpoint url ကို ထည့်ပေးရမှာ ဖြစ်ပါတယ်။ Headers, Query, Body မှာကတော့ ကိုယ်တင်မယ့် api endpoint မှာပါဝင်မယ့် credentials တွေကို ဖြည့်သွင်းပေးရမှာ ဖြစ်ပါတယ်။ အခု ကျွန်တော့် api endpoint မှာကတော့ url ဆိုတဲ့ query parameter တစ်ခုသာ လိုတဲ့အတွက် query ဆိုတဲ့ tab အောက်မှာ ထည့်ပေးထားတာ ဖြစ်ပါတယ်။

Fig.(7) ရဲ့ Gateway tab မှာကတော့ မိမိ api endpoint မှာလိုအပ်တဲ့ authentication တွေကို ရွေးချယ်ပြီး အသုံးပြုနိုင်ပါတယ်။ ကိုယ်တိုင်သတ်မှတ်ထားတဲ့ authentication မရှိပါက rapidapi မှ support လုပ်ပေးထားတဲ့ rapid auth only ကို အသုံးပြုနိုင်ပါတယ်။

Fig.(8) က Monetize tab မှာကတော့ မိမိ api ကို ရောင်းဖို့အတွက် Basic, Pro, Ultra, Mega အစရှိတဲ့ plan တွေကို သတ်မှတ်ပေးလို့ ရတဲ့နေရာ ဖြစ်ပါတယ်။ Plan တစ်ခုချင်းစီမှာ Pay per Use နဲ့ Monthly Subscription ဆိုပြီး plan type နှစ်ခုစီ ပါဝင်မှာဖြစ်ပါတယ်။

Pay per Use ကတော့ သုံးသလောက်ပေး ပုံစံဖြစ်ပြီး Monthly Subscription ကတော့ တစ်လချင်းစီအလိုက် subscription fees ပေးရမယ့် ပုံစံဖြစ်ပါတယ်။ Rate limit ကတော့ (1) minute မှာ request ဘယ်နှစ်ခု အများဆုံးလက်ခံမလဲဆိုတာကို သတ်မှတ်ပေးရတာဖြစ်ပါတယ်။ Subscription price ကတော့ တစ်လချင်းဝယ်သုံးရတဲ့ပုံစံဖြစ်တဲ့ Monthly Subscription plan type မှာသာ ပါဝင်မှာဖြစ်ပါတယ်။

Fig.(10) မှာပါတဲ့ Quota Type ကတော့ Unlimited, Monthly, Daily အစရှိတဲ့ plan တွေကို ရွေးချယ်ပေးရတာ ဖြစ်ပါတယ်။ Quota Limit ကတော့ တစ်ရက် (သို့) တစ်လမှာ api request ကို ဘယ်လောက်အထိပဲ လက်ခံမယ်ဆိုတာကို သတ်မှတ်ပေးရတာ ဖြစ်ပါတယ်။ Limit Type မှာပါတဲ့ soft limit ကတော့ သတ်မှတ်ထားတဲ့ request limit ရောက်တဲ့အချိန်မှာ user က ထို api request ကို ကျသလောက်ထပ်ပေးပြီး ဆက်သုံးနေလို့ ရနေမှာဖြစ်သော်လည်း hard limit ကတော့ သတ်မှတ်ထားတဲ့ request limit ရောက်တဲ့အချိန်မှာ user က ထို api request ကို ဆက်လက် အသုံးပြုလို့ မရတော့မှာ ဖြစ်ပါတယ်။ Overages ကတော့ သတ်မှတ်ထားတဲ့ request limit ကျော်သွားတဲ့အခါ api request တစ်ခုကို ကျသင့်မယ့်ပမာဏကို ထည့်သွင်းပေးရမှာဖြစ်ပါတယ်။ ပုံပါအချက်အလက်တွေအတိုင်း လုပ်ပြီးပြီဆိုရင်တော့ မိမိ api က RapidAPI Marketplace ပေါ်သို့ရောက်ရှိသွားမှာ ဖြစ်ပါတယ်။

အထက်ပါ အကြောင်းအရာများကတော့ API တစ်ခုကို ဘယ်လို create လုပ်ရမလဲနဲ့ RapidAPI ပေါ်မှာ ဘယ်လို sell လုပ်ရမလဲဆိုတာကို ဝေမျှပေးထားတာဖြစ်ပါတယ်။ အဆုံးထိ ဖတ်ရှုပေးတဲ့အတွက် ကျေးဇူးတင်ပါတယ်ခင်ဗျ။