Python SDK
Python මඟින් ඔබේ හොස්ටිං පාලනය කරන්න
zinn-sdk යනු Zinn Digital® API සඳහා වන ටයිප් කළ Python සේවාලාභියෙකි, එය API ගොඩනගා ඇති එම OpenAPI පිරිවිතරයෙන්ම ජනනය කර ඇත. සෑම මෙහෙයුමකටම සමමුහුර්ත සහ 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 යතුරක් භාවිතා කරන අතර, එය එය බෙයාරර් ටෝකනයක් ලෙස යවයි. යතුරක් සතුව පවතින්නේ ඔබ එය සාදන විට ලබා දෙන අවසරයන් පමණක් වන අතර, ඔබට එය ඕනෑම වේලාවක අවලංගු කළ හැකිය. එය පරිසර විචල්‍යයක හෝ ඔබේ රහස්‍ය ගබඩාවේ තබා ගන්න, කිසි විටෙකත් මූල කේතය තුළ නොතබන්න.
ඔබට ලැබෙන දේ
ටයිප් කරන ලද මාදිලි
ඉල්ලීම් සහ ප්‍රතිචාර යනු වර්ග ඉඟි සහිත 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 එකක් තිබේද?
ඔව්. pip install zinn-sdk සමඟ PyPI වෙතින් zinn-sdk ස්ථාපනය කර zinn_sdk ආයාත කරන්න. එය සමමුහුර්ත සහ asyncio ඇමතුම් සහිත අපගේ OpenAPI පිරිවිතරයෙන් ජනනය කරන ලද ටයිප් කළ සේවාලාභියෙකි.
Python SDK තුළ දී ඇති අන්ත ලක්ෂ්යය පිහිටා ඇත්තේ කොහේද?
ක්රියාකාරකම් zinn_sdk.api යටතේ API ප්රදේශය අනුව කාණ්ඩ කර ඇති අතර ඒවායේ ක්රියාකාරකම් id (operation id) අනුව snake case වලින් නම් කර ඇත. උදාහරණයක් ලෙස, වෙබ් අඩවි ලැයිස්තුගත කිරීම zinn_sdk.api.hosting.list_sites වේ.
සහාය දක්වන්නේ කුමන Python සංස්කරණ සඳහාද?
Python 3.11 සහ පසු අනුවාද.
සෑම අන්ත ලක්ෂ්‍යයක්ම ගවේෂණය කරන්න
SDK මඟින් ඇමතිය හැකි සෑම මෙහෙයුමක්ම එහි පරාමිතීන්, ප්‍රතිචාර සහ අවසරයන් සමඟින් API පරිශීලන මාර්ගෝපදේශයෙහි විස්තර කර ඇත.