Python SDK
Ṣakoso igbalejo rẹ lati Python
zinn-sdk jẹ́ oníbàárà Python tí a fún ní irúfẹ́ fún Zinn Digital® API, tí a ṣẹ̀dá láti inú àpèjúwe OpenAPI kan náà tí a kọ́ API náà láti inú rẹ̀. Gbogbo iṣẹ́ ló ní àwọn àyípadà ti amuṣiṣẹpọ̀ àti asyncio, àti gbogbo ìbéèrè àti ìdáhùn jẹ́ àwòṣe tí a fún ní irúfẹ́.
Fi sori ẹrọ
Pọọkẹẹji naa wa lori PyPI gẹgẹ bi zinn-sdk ati pe a n gbe wọle gẹgẹ bi zinn_sdk. O nilo Python 3.11 tabi eyiti o tẹle e.
pip install zinn-sdkÌbẹ̀rẹ̀ kíákíá
Ṣe akojọ awọn agbegbe igbalejo gbogbogbo laisi kọkọrọ kan, lẹhinna ṣe akojọ awọn aaye tirẹ pẹlu ọkan.
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)Ijeri-ẹni
Àwọn ojú-ìpari àkójọ gbogbogbò, bíi àwọn agbègbè àti àwọn ètò, kò nílò ẹ̀rí ìdánimọ̀ kankan. Ohun gbogbo mìíràn ń lo kọ́kọ́rọ́ API fún àjọ kọ̀ọ̀kan tí a gbé fún AuthenticatedClient, èyí tí ń fi ránṣẹ́ gẹ́gẹ́ bí àmì agbérù. Kọ́kọ́rọ́ kan máa ń gbé àwọn àṣẹ tí ẹ fún un nígbà tí ẹ ṣẹ̀dá rẹ̀ nìkan, ẹ sì lè fagilé e nígbàkigbà. Tọ́jú rẹ̀ sínú àyípadà àyíká tàbí ibi ìpamọ́ àṣírí yín, kì í ṣe nínú kóòdù orísun rárá.
Ohun ti ẹ o gba
Àwọn àwòṣe tí a tẹ́wọ́gbà
Awọn ibeere ati awọn idahun jẹ awọn awoṣe attrs pẹlu awọn amọran iru, nitorina olootu rẹ ati oluyẹwo iru rẹ loye gbogbo aaye.
Múdàgbàsopọ̀ àti asyncio
Iṣẹ́ kọ̀ọ̀kan ní àwọn iṣẹ́ sync, sync_detailed, asyncio àti asyncio_detailed, tí a sọ lórúkọ lẹ́yìn iṣẹ́ náà ní snake case tí a sì tò gẹ́gẹ́ bí agbègbè API lábẹ́ zinn_sdk.api.
Ti ipilẹṣẹ lati inu alaye pato
A máa ń tẹ ẹ̀yà tuntun jáde lẹ́sẹ̀kẹsẹ̀ nígbàkúgbà tí àfihàn OpenAPI bá yípadà. Àwọn iṣẹ́ díẹ̀ tí ẹ̀rọ ìṣẹ̀dá kò tíì lè ṣàfihàn ni a ń tò lẹ́sẹẹsẹ tí a sì ń yẹ̀wò ní gbogbo ìgbà tí a bá gbé ẹ̀yà jáde, wọ́n sì wà lárọ̀ọ́wọ́tó nípasẹ̀ REST API.
Awọn ipe alaibikita akoko
Ìpè kanna pẹlu asyncio, ti n da ipo HTTP pada pẹlu idahun ti a ṣe ayẹwo.
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())Àwọn ọ̀nà àsopọ̀
Àwọn ìbéèrè
Ṣe o ni Python SDK kan?
Bẹ́ẹ̀ ni. Fi zinn-sdk sori ẹ̀rọ láti PyPI pẹ̀lú pip install zinn-sdk kí o sì gbé zinn_sdk wọlé. Ó jẹ́ oníbàárà tí a tẹ̀ láti inú ìṣàpèjúwe OpenAPI wa, pẹ̀lú àwọn ìpè amuṣiṣẹpọ̀ àti asyncio.
Nibo ni aaye ipari ti a fun wa wa ninu Python SDK?
A ṣètò àwọn iṣẹ́ nípa agbègbè API lábẹ́ zinn_sdk.api tí a sì sọ wọ́n lórúkọ nípa id iṣẹ́ wọn ní snake case. Fún àpẹẹrẹ, ṣíṣe àkójọ àwọn ojú-òpó wẹ́ẹ̀bù jẹ́ zinn_sdk.api.hosting.list_sites.
Awọn ẹya Python wo ni a ṣe atilẹyin?
Python 3.11 ati ẹya ti o tẹle.
Ṣawari gbogbo aaye ipari
Gbogbo iṣẹ́ tí SDK lè pè ni a ṣe àpèjúwe rẹ̀ nínú ìtọ́kasí API, pẹ̀lú àwọn pàrámítà, àwọn ìdáhùn, àti àwọn àṣẹ rẹ̀.