Python SDK
သင့်ဟိုစတင်းကို Python မှ ထိန်းချုပ်ပါ
zinn-sdk သည် API ကို တည်ဆောက်ထားသည့် တူညီသော OpenAPI သတ်မှတ်ချက်မှ ထုတ်လုပ်ထားသော Zinn Digital® API အတွက် အမျိုးအစားသတ်မှတ်ထားသည့် Python ကလိုင်းယင့်တစ်ခု ဖြစ်ပါသည်။ လုပ်ဆောင်ချက်တိုင်းတွင် synchronous နှင့် asyncio မူကွဲများပါရှိပြီး တောင်းဆိုမှုနှင့် တုံ့ပြန်မှုတိုင်းသည် အမျိုးအစားသတ်မှတ်ထားသော မော်ဒယ်တစ်ခု ဖြစ်ပါသည်။
ထည့်သွင်းပါ
အဆိုပါ ပက်ကေ့ဂျ်ကို PyPI တွင် zinn-sdk အဖြစ် ရရှိနိုင်ပြီး zinn_sdk အဖြစ် ထည့်သွင်း အသုံးပြုသည်။ ၎င်းအတွက် Python 3.11 သို့မဟုတ် နောက်ပိုင်းဗားရှင်း လိုအပ်ပါသည်။
pip install zinn-sdkအမြန်စတင်ရန်
ကီးမပါဘဲ အများသုံး လက်ခံဆောင်ရွက်ပေးသည့် ဒေသများကို စာရင်းပြုစုပါ၊ ထို့နောက် ကီးတစ်ခုဖြင့် သင့်ကိုယ်ပိုင်ဆိုက်များကို စာရင်းပြုစုပါ။
import os
from zinn_sdk import AuthenticatedClient, Client
from zinn_sdk.api.catalog import list_public_hosting_regions
from zinn_sdk.api.hosting import list_sites
# Public catalogue endpoints need no key.
public = Client(base_url="https://api.zinndigital.com")
regions = list_public_hosting_regions.sync(client=public)
print([region.slug for region in regions.data])
# Everything else uses a per-organisation API key.
api = AuthenticatedClient(base_url="https://api.zinndigital.com", token=os.environ["ZINN_API_KEY"])
page = list_sites.sync(client=api, limit=5)
for site in page.data:
print(site.name, site.status)အထောက်အထားစိစစ်ခြင်း
ဒေသများနှင့် အစီအစဉ်များကဲ့သို့သော အများသုံး ကတ်တလောက် အဆုံးမှတ်များသည် မည်သည့် အထောက်အထားမျှ မလိုအပ်ပါ။ အခြားအရာအားလုံးသည် AuthenticatedClient ထံသို့ ပေးပို့သော အဖွဲ့အစည်းအလိုက် API ကီးကို အသုံးပြုပြီး ၎င်းကို bearer token အဖြစ် ပေးပို့ပါသည်။ ကီးတစ်ခုတွင် သင်ဖန်တီးချိန်၌ သင်ပေးအပ်ထားသော ခွင့်ပြုချက်များသာ ပါရှိပြီး ၎င်းကို အချိန်မရွေး ပြန်လည်ရုပ်သိမ်းနိုင်ပါသည်။ ၎င်းကို ပတ်ဝန်းကျင်ပြောင်းလဲနိုင်သောတန်ဖိုး သို့မဟုတ် သင့်လျှို့ဝှက်သိုလှောင်ခန်းထဲတွင် ထားပါ၊ မည်သည့်အခါမျှ အရင်းအမြစ်ကုဒ်ထဲတွင် မထားပါနှင့်။
သင်ရရှိမည့်အရာ
အမျိုးအစားသတ်မှတ်ထားသော မော်ဒယ်များ
တောင်းဆိုမှုများနှင့် တုံ့ပြန်မှုများသည် အမျိုးအစား အရိပ်အမြွက်များပါရှိသော attrs မော်ဒယ်များဖြစ်သောကြောင့် သင်၏တည်းဖြတ်စနစ်နှင့် အမျိုးအစားစစ်ဆေးစနစ်တို့သည် အကွက်တိုင်းကို နားလည်နိုင်ပါသည်။
ချိန်ကိုက်ခြင်းနှင့် asyncio
လုပ်ဆောင်ချက်တစ်ခုစီတွင် sync၊ sync_detailed၊ asyncio နှင့် asyncio_detailed လုပ်ဆောင်ချက်များရှိပြီး၊ snake case ဖြင့် လုပ်ဆောင်ချက်အမည်အတိုင်း ပေးထားကာ zinn_sdk.api အောက်ရှိ API ဧရိယာအလိုက် အုပ်စုဖွဲ့ထားသည်။
သတ်မှတ်ချက်မှ ထုတ်ပေးထားသည်
OpenAPI သတ်မှတ်ချက် ပြောင်းလဲသွားသည့်အခါတိုင်း ဗားရှင်းအသစ်တစ်ခုကို အလိုအလျောက် ထုတ်ဝေပါသည်။ ထုတ်လုပ်စနစ်မှ ဖော်ပြနိုင်ခြင်း မရှိသေးသည့် လုပ်ဆောင်ချက် အနည်းငယ်ကို ထုတ်ဝေမှုတိုင်းတွင် စာရင်းပြုစုပြီး စစ်ဆေးပေးထားပြီး REST API မှတစ်ဆင့် ဆက်လက်ရယူအသုံးပြုနိုင်ပါသည်။
အဆင်ခ်ခေါ်ဆိုမှုများ
HTTP အခြေအနေနှင့် ခွဲခြမ်းစိတ်ဖြာထားသော တုံ့ပြန်မှုနှစ်ခုစလုံးကို ပြန်ပေးသည့် asyncio ဖြင့် ခေါ်ဆိုမှု အတူတူပင် ဖြစ်သည်။
import asyncio
from zinn_sdk.api.hosting import list_sites
# Every operation has sync, sync_detailed, asyncio and asyncio_detailed variants.
async def main() -> None:
response = await list_sites.asyncio_detailed(client=api, limit=5)
print(response.status_code, len(response.parsed.data))
asyncio.run(main())မေးခွန်းများ
သင့်တွင် Python SDK ရှိပါသလား။
ဟုတ်ကဲ့။ zinn-sdk ကို PyPI မှ pip install zinn-sdk ဖြင့် ထည့်သွင်းပြီး zinn_sdk ကို တင်သွင်းပါ။ ၎င်းသည် synchronous နှင့် asyncio ခေါ်ဆိုမှုများပါရှိသော ကျွန်ုပ်တို့၏ OpenAPI သတ်မှတ်ချက်မှ ထုတ်လုပ်ထားသော typed client တစ်ခု ဖြစ်ပါသည်။
သတ်မှတ်ထားသော အဆုံးမှတ်သည် Python SDK တွင် မည်သည့်နေရာတွင် ရှိသနည်း။
လုပ်ဆောင်ချက်များကို zinn_sdk.api အောက်ရှိ API ဧရိယာအလိုက် အုပ်စုဖွဲ့ထားပြီး ၎င်းတို့၏ လုပ်ဆောင်ချက် id အတိုင်း snake case ဖြင့် အမည်ပေးထားသည်။ ဥပမာအားဖြင့်၊ ဝဘ်ဆိုက်များကို စာရင်းပြုစုခြင်းသည် zinn_sdk.api.hosting.list_sites ဖြစ်သည်။
မည်သည့် Python ဗားရှင်းများကို ပံ့ပိုးထားသနည်း။
Python 3.11 နှင့် နောက်ပိုင်းထွက်ဗားရှင်းများ။
အဆုံးမှတ်တိုင်းကို လေ့လာပါ
SDK မှ ခေါ်ဆိုနိုင်သည့် လုပ်ဆောင်ချက်တိုင်းကို ၎င်း၏ ပါရာမီတာများ၊ တုံ့ပြန်မှုများနှင့် ခွင့်ပြုချက်များနှင့်အတူ API အညွှန်းတွင် ဖော်ပြထားပါသည်။