መመሪያዎች

REST API እንዴት እንደሚገነቡ፡ ዲዛይን፣ ደህንነት እና ማሰማራት

REST API ለመገንባት፣ መተግበሪያዎ የሚያስተዳድራቸውን ግብዓቶች (ለምሳሌ ተጠቃሚዎች፣ ትዕዛዞች፣ ቦታ ማስያዣዎች) ይዘርዝሩ፤ እያንዳንዳቸውን እንደ /orders እና /orders/{id} ያለ URL ይስጡ፤ ለድርጊቶች HTTP ዘዴዎችን ይጠቀሙ፦ GET ለማንበብ፣ POST ለመፍጠር፣ PATCH ለማዘመን፣ DELETE ለመሰረዝ። ትክክለኛ የሁኔታ ኮዶች ያለው JSON ይመልሱ፣ እያንዳንዱን ግብዓት ያረጋግጡ፣ ማረጋገጫ እና በእያንዳንዱ መዝገብ ላይ የፈቃድ ፍተሻ በሰርቨሩ ላይ ይጠይቁ፣ ዝርዝሮችንም በገጾች ይከፋፍሉ። ከዚያ ኤፒአይ ነጥቦቹን ይመዝግቡ እና ኤፒአይውን ከHTTPS ጀርባ ያሰማሩ።

ይህ መመሪያ የንድፍ ውሳኔዎችን፣ የተዘጋጁ መንገዶችን፣ ለAI አፕ ገንቢ እንደ Mythex ጥያቄዎችንና የደህንነት ቀዳዳ የሚፈጥሩ ስህተቶችን ይሸፍናል። APIs አዲስ ከሆኑ በAPI ምንድን ነው ይጀምሩ።

REST API መቼ ያስፈልግዎታል

  • የድር ፍሮንትኤንድዎ ዳታን ከሰርቨር ማስቀመጥ እና መጫን ሲፈልግ
  • የሞባይል መተግበሪያ፣ አጋር ወይም አውቶሜሽን መሳሪያ ወደ ዳታዎ መድረስ ሲፈልግ
  • ሌሎች አገልግሎቶች ክስተቶችን ወደ እርስዎ ሲልኩ (ዌብሁክስ)
  • ስራን በፍሮንትኤንድ እና በባክኤንድ ቡድኖች መካከል ሲከፋፍሉ

REST በጣም የተለመደው ዘዴ ነው፣ ግን ብቸኛው አይደለም። REST vs GraphQL አንድ ተለዋዋጭ የጥያቄ መጨረሻ ነጥብ መቼ የተሻለ እንደሚስማማ ያብራራል።

መጀመሪያ ዲዛይን ያድርጉ፡ ግብዓቶች እና መንገዶች

በመተግበሪያዎ ውስጥ ያሉ ስሞችን እና ሰዎች ከእነሱ ጋር ምን እንደሚያደርጉ ይጻፉ። ለቀላል የቦታ ማስያዣ መተግበሪያ፦

ዘዴመንገድምን ያደርጋልየስኬት ኮድ
GET/api/bookingsየጠሪውን ቦታ ማስያዣዎች ይዘርዝራል (በገጽ የተከፈለ)200
POST/api/bookingsቦታ ማስያዣ ይፈጥራል201
GET/api/bookings/{id}አንድ ቦታ ማስያዣ ያገኛል200
PATCH/api/bookings/{id}አንዳንድ መስኮችን ይቀይራል200
DELETE/api/bookings/{id}ቦታ ማስያዣን ይሰርዛል204
GET/api/healthለክትትል የጤና ፍተሻ200

እነዚህ ወደ ፍጠር፣ አንብብ፣ አዘምን እና ሰርዝ (CRUD) ይቀየራሉ፤ CRUD ምንድን ነው የሚለውን ይመልከቱ። መከተል የሚገባቸው ልማዶች፦

  • የብዙ ቁጥር ስሞች፣ ግስ የለም በURL ውስጥ፦ /bookings፣ /getBookings አይደለም።
  • ባለቤትነትን ለማሳየት አንድ ደረጃ ብቻ ጎጆ ያድርጉ፦ /bookings/{id}/notes።
  • ከCRUD ውጪ ያሉ ድርጊቶች እንደ ንዑስ ግብዓት ሊቀመጡ ይችላሉ፤ POST /bookings/{id}/cancel ከድብቅ PATCH የበለጠ ግልጽ ነው።
  • ወጥ ስያሜ ለመስኮች፣ ለምሳሌ created_at በሁሉም ቦታ።

የሁኔታ ኮዶች እና ስህተቶች

ደንበኞች ጽሑፍ ሳይተነትኑ ምን እንደተፈጠረ እንዲያውቁ መደበኛ HTTP ኮዶችን ይጠቀሙ፦

ኮድትርጉምመቼ ይጠቀሙ
200OKየተሳካ ንባብ ወይም ዝማኔ
201CreatedPOST አንድ ነገር ሲፈጥር
204No Contentምንም የማይመለስበት ስኬት
400Bad Requestግብዓቱ ማረጋገጫውን ካላለፈ
401Unauthorizedአልገቡም ወይም ቶከኑ የተሳሳተ ነው
403Forbiddenገብተዋል ግን አይፈቀድልዎትም
404Not Foundየለም፣ ወይም ጠሪው መኖሩን ማወቅ የለበትም
409Conflictተባዝቷል፣ ወይም ቦታው ቀድሞ ተይዟል
429Too Many Requestsየጥያቄ ገደቡ ደርሷል
500Server Errorበእርስዎ በኩል የሆነ ነገር ተበላሽቷል

ስህተቶችን በአንድ ወጥ የJSON ቅርጽ ይመልሱ፣ ለምሳሌ {"error": {"code": "slot_taken", "message": "ያ ሰዓት ከአሁን በኋላ አይገኝም።"}}፤ እና የስታክ ትሬስ ወይም የዳታቤዝ ስህተቶችን በምላሾች ውስጥ ፈጽሞ አታካትቱ።

አማራጮች እና ለውጦች

ውሳኔቀላሉ ምርጫአማራጭ
ኤፒአይው የሚኖርበት ቦታበድር ፍሬምወርክዎ ውስጥ ያሉ የኤፒአይ መንገዶችለብዙ ደንበኞች ወይም ለተለየ ቋንቋ የሚጠቅም የተለየ የኤፒአይ አገልግሎት
ማረጋገጫለራስዎ ድር መተግበሪያ የሴሽን ኩኪዎችለሞባይል መተግበሪያዎች እና ለሶስተኛ ወገኖች ቶከኖች (bearer tokens ወይም API keys)
ገጽ መከፈል?page=2&limit=20ለትልልቅ እና ለሚቀያየሩ ዝርዝሮች የበለጠ የተረጋጋ በጠቋሚ ላይ የተመሰረተ (?after=...)
ቨርዥንሰዎች ውጭ ተጠቃሚ እስኪኖሮት ድረስ የለምሌሎች ሲመኩበት በመንገዱ ውስጥ /v1/
ሰነዶችመንገዶችን የሚዘረዝር READMEመሳሪያዎች ወደ በይነተገናኝ ሰነድ እና ወደ ደንበኛ ኮድ የሚቀይሩት OpenAPI ስፔክ

በደረጃ

  1. ግብዓቶችን እና መንገዶችን ዘርዝሩ ከላይ እንደተባለው፣ ማን እያንዳንዱን ሊጠራ እንደሚችል ጨምሮ።
  2. ዳታውን ሞዴል ያድርጉ በዳታቤዝዎ ውስጥ በሚፈልጓቸው መስኮች እና ግንኙነቶች።
  3. የንባብ መንገዶችን መጀመሪያ ይገንቡ፣ ከዚያ ፍጠር፣ አዘምን እና ሰርዝ።
  4. ግብዓትን በእያንዳንዱ ጽሑፍ ላይ ያረጋግጡ በስኪማ ላይብረሪ፦ የሚፈለጉ መስኮች፣ ዓይነቶች፣ ርዝመቶች፣ የተፈቀዱ እሴቶች። ያልታወቁ መስኮችን ውድቅ ያድርጉ።
  5. ማረጋገጫ ይጨምሩ፣ ከዚያ በመዝገብ ደረጃ ፈቃድ፦ /bookings/42 መጫን የቦታ ማስያዣ 42 የጠሪው መሆኑን ማረጋገጥ አለበት፣ ዝም ብሎ አንድ ሰው መግባቱን ብቻ ሳይሆን።
  6. እያንዳንዱን ዝርዝር በገጽ ይከፋፍሉ እና የገጽ መጠኑን ይገድቡ።
  7. የመግቢያ እና ውድ መንገዶችን ይገድቡ። የጥያቄ ገደብ ይመልከቱ።
  8. CORS ያዋቅሩ የሚሆነው ሌሎች ዶሜኖች ያሉ ብራውዘሮች ኤፒአዩን መጥራት ካለባቸው ብቻ ነው፤ እነዚያንም ምንጮች በግልጽ ይዘርዝሩ። የCORS ስህተቶችን እንዴት መፍታት የሚያዩዋቸውን ስህተቶች ያብራራል።
  9. ለእያንዳንዱ መንገድ ሰነዶች እና ፈተናዎች ይጻፉ፣ የውድቀት ጉዳዮችን ጨምሮ።
  10. ያሰማሩ ሚስጥሮች በአካባቢ ተለዋዋጮች፣ HTTPS፣ ምዝግብ እና የጤና ፍተሻ ጋር።

ለAI ገንቢዎ የሚሰጡ ጥያቄዎች

መሰረት፦

ለቦታ ማስያዣዎች REST API ይፍጠሩ በሚከተሉት መንገዶች፦ GET /api/health፣ GET /api/bookings (በገጽ የተከፈለ፣ በገጽ ቢበዛ 50)፣ POST /api/bookings፣ GET /api/bookings/:id፣ PATCH /api/bookings/:id፣ DELETE /api/bookings/:id። ዳታውን በዳታቤዛችን ውስጥ ያስቀምጡ። የጥያቄ አካላትን በስኪማ ላይብረሪ ያረጋግጡ እና ያልታወቁ መስኮችን ውድቅ ያድርጉ። የJSON ስህተቶችን እንደ {"error": {"code", "message"}} በትክክለኛ የሁኔታ ኮዶች (400፣ 401፣ 403፣ 404፣ 409) ይመልሱ። ሚስጥሮችን በአካባቢ ተለዋዋጮች ያስቀምጡ።

ደህንነት፦

በእያንዳንዱ የቦታ ማስያዣ መንገድ ላይ መግባት ይጠይቁ። በእያንዳንዱ ንባብ፣ ዝማኔ እና ስረዛ ላይ ቦታ ማስያዣው የአሁኑ ተጠቃሚ መሆኑን በሰርቨሩ ላይ ያረጋግጡ፤ ካልሆነ 404 ይመልሱ። የተጠቃሚ IDs ወይም ሚናዎችን ከጥያቄው አካል ፈጽሞ አትቀበሉ። POST /api/bookings በተጠቃሚ በደቂቃ 20 እንዲሆን ይገድቡ። ስህተቶችን በሰርቨሩ ላይ ይመዝግቡ፤ ስታክ ትሬስ ለደንበኛው አትመልሱ።

ሰነዶች፦

የእነዚህን መንገዶች OpenAPI መግለጫ እና ለእያንዳንዱ ምሳሌ ጥያቄዎች እና ምላሾች ያሉት አጭር README ይጻፉ።

ኤፒአይዎን መፈተሽ

ከፍሮንትኤንዱ ውጭ ይሞክሩ፣ አጥቂዎች እንደሚያደርጉት፦

  • እያንዳንዱ መንገድ በትክክለኛ ግብዓት ይሰራል እና የተገለጸውን ቅርጽ እና ኮድ ይመልሳል
  • የጎደሉ ወይም ልክ ያልሆኑ መስኮች ግልጽ መልዕክት ያለው 400 ይመልሳሉ
  • ቶከን ከሌለ በእያንዳንዱ የተጠበቀ መንገድ 401 ይመለሳል
  • ተጠቃሚ A የተጠቃሚ B መዝገብ በIDው ሲጠይቅ 404 ወይም 403 ያገኛል
  • ዝርዝሮች በገጽ ተከፍለዋል፤ ትልቅ limit ይገደባል
  • የተባዙ ወይም የሚጋጩ ፍጠሮች 500 ሳይሆን 409 ይመልሳሉ
  • የጥያቄ ገደቦች 429 ይመልሳሉ
  • የስህተት ምላሾች ስታክ ትሬስ፣ SQL ወይም ሚስጥር አይይዙም
  • CORS የሚፈቅደው ያሰቡትን ምንጮች ብቻ ነው

የተለመዱ ስህተቶች

  • መግባትን ብቻ ማረጋገጥ፣ ባለቤትነትን አለማረጋገጥ። በጣም የተለመደው የኤፒአይ ክፍተት፦ ማንኛውም የገባ ተጠቃሚ IDውን በመቀየር የማንኛውንም መዝገብ ማንበብ ይችላል።
  • ደንበኛውን ማመን። በጥያቄ አካል ውስጥ ያሉ ዋጋዎች፣ ሚናዎች እና የተጠቃሚ IDs ሊቀየሩ ይችላሉ።
  • ሙሉ የዳታቤዝ ረድፎችን መመለስ። የይለፍ ቃል ሃሾች እና ውስጣዊ መስኮች ይወጣሉ። እያንዳንዱ ምላሽ ምን እንደሚያካትት ይምረጡ።
  • ወሰን የሌላቸው ዝርዝሮች። ለእያንዳንዱ መዝገብ አንድ ጥያቄ ሙሉ መተግበሪያውን ሊያዘገይ ይችላል።
  • በውስጡ የስህተት መልዕክት ያለው 200 OK። ደንበኞችና ክትትል መሳሪያዎች ያልተሳካ መሆኑን ማወቅ አይችሉም።
  • ሁሉን እንዲፈቅድ የተዋቀረ CORS ኩኪዎችን በሚጠቀም ኤፒአይ ላይ።
  • የጤና ፍተሻ ወይም ምዝግብ የለም፤ ስለዚህ ስለመቋረጥ የምታውቁት ከተጠቃሚዎች ነው።

ለሰፊ ቅድመ-ማስጀመሪያ ማረጋገጫ፣ ለAI-የተገነቡ መተግበሪያዎች የደህንነት ማረጋገጫ ዝርዝር ይመልከቱ።

በMythex REST API መገንባት

ለMythex እንደ የአፑ አካል ወይም የራሱ አገልግሎት API መጠየቅ ትችላላችሁ። የሰነዱ REST API backend የመነሻ ጥያቄ አለው፦ ፍሬምወርካችሁንና መንገዶቻችሁን ሰይሙ፣ ግልጽ የJSON ስህተቶችን ጠይቁ፣ ሚስጥሮችን በአካባቢ ተለዋዋጮች አስቀምጡ፣ እና Dockerfile አካትቱ። Node፣ Python፣ C#፣ Java እና ሌሎች የኮንቴይነር ጀርባ ክፍሎች በDockerfile ይታተማሉ፣ Mythex ማሰማራቱን ከPublish ያስተናግዳል (API backends)። ፕሮጀክት ድረ-ገጽና API ጎን ለጎን ሊያሄድ ይችላል፣ በቅድመ-እይታ መካከል መቀያየር ይችላሉ። ሚስጥሮችን እንደ የፕሮጀክት ሚስጥሮች ያስቀምጡ፣ API ዳታቤዝ ከፈለገ በውይይት ይጠይቁ፦ እያንዳንዱ ፕሮጀክት የራሱ Postgres ዳታቤዝ ሊኖረው ይችላል፣ በሁሉም እቅዶች ተካትቷል። ወኪሉ API ለእናንተ ሊፈትሽ ይችላል፣ እና በPro ላይ ኮዱን በአርታኢና ተርሚናል እራሳችሁ ማረም ወይም በባለሁለት አቅጣጫ GitHub ማመሳሰል ማቆየት ትችላላችሁ። ከAPIዎ ጎን ለሚሄድ መርሐግብር የተያዘ ሥራ ዳራ ሥራዎችን እንዴት እንደሚያሄዱ ይመልከቱ።

ጥያቄዎች

REST API ምንድን ነው?

REST API ፕሮግራሞች በHTTP ላይ ከመተግበሪያዎ ዳታ ጋር እንዲሰሩ የሚያስችል መንገድ ነው። እያንዳንዱ የዳታ አይነት እንደ /orders ያለ የራሱ URL ያለው ግብዓት ነው፤ መደበኛ ዘዴዎችም በእሱ ላይ ይሰራሉ፦ GET ለማንበብ፣ POST ለመፍጠር፣ PATCH ወይም PUT ለማዘመን፣ እና DELETE ለማስወገድ። ዳታ በአብዛኛው በJSON ይላካል።

REST API በየትኛው ቋንቋ ልገነባ?

ለእናንተ ወይም ለቡድናችሁ ጥገና ማድረግ የሚቻለውን ተጠቀሙ። Node.js ከ Express ወይም Fastify፣ Python ከFastAPI፣ እና C# ወይም Java ማዕቀፎች ሁሉም ጥሩ ይሰራሉ። ለመንገዶች፣ ለሁኔታ ኮዶች፣ ለማረጋገጫ (validation) እና ለመለያ ማረጋገጫ (authentication) ያሉት የንድፍ ህጎች ከቋንቋው በላይ ይቆጠራሉ። Mythex APIs በNode፣ Python፣ Java፣ C# ወይም በDockerfile እንደ ድር ሰርቨር የሚሠራ ማንኛውም ያስኬዳል፣ ስለዚህ የሚያውቁትን መምረጥ ትችላላችሁ።

REST API እንዴት ልጠብቀው?

ለእያንዳንዱ ህዝብ ያልሆነ መንገድ ማረጋገጫ ይጠይቁ፤ ጥሪ አቅራቢው እያንዳንዱን የተለየ መዝገብ ማግኘት እንደሚችል በሰርቨሩ ላይ ያረጋግጡ፤ ሁሉንም ግብዓት ያረጋግጡ፤ HTTPS ይጠቀሙ፤ የጥያቄዎችን ብዛት ይገድቡ፤ ሚስጥሮችን በአካባቢ ተለዋዋጮች (environment variables) ያስቀምጡ። ከደንበኛው የተላኩ IDs ወይም ሚናዎችን ፈጽሞ አትመኑ።

ለREST API የተለየ ባክኤንድ ያስፈልገኛል?

ሁልጊዜ አይደለም። እንደ Next.js ያሉ ማዕቀፎች የAPI መስመሮችን ከገጾች ጎን ሊያገለግሉ ይችላሉ። የተለየ API አገልግሎት ብዙ ደንበኞች (ድር፣ ሞባይል፣ አጋሮች) ሲጠቀሙት ወይም የራሱ ቋንቋ ወይም ማስፋፊያ ሲፈልግ ይጠቅማል። በMythex ድረ-ገጽና API በአንድ ፕሮጀክት ሊኖሩና አንድ ላይ ሊታተሙ ይችላሉ።

Mythex · Pricing · በAI ማንኛውንም ነገር ይገንቡ · የድር ጣቢያ እና የመተግበሪያ ቴምፕሌቶች · Mythex ከሌሎች ጋር ሲነጻጸር · የAI መተግበሪያ ግንባታ የቃላት መዝገበ-ቃላት · ነፃ የAI መተግበሪያ መገንቢያ መሳሪያዎች · English

English العربية Български বাংলা Bosanski Català Čeština Dansk Deutsch Ελληνικά Español Español (España) Eesti فارسی Suomi Français Français (Canada) ગુજરાતી हिन्दी Hrvatski Magyar Հայերեն Bahasa Indonesia Íslenska Italiano 日本語 ქართული Қазақ тілі ಕನ್ನಡ 한국어 Lietuvių Latviešu Македонски മലയാളം Монгол मराठी Bahasa Melayu မြန်မာ Norsk bokmål Nederlands ਪੰਜਾਬੀ Polski Português (Brasil) Português (Portugal) Română Русский Slovenčina Slovenščina Soomaali Shqip Srpski Svenska Kiswahili தமிழ் తెలుగు ไทย Tagalog Türkçe Українська اردو Tiếng Việt 简体中文 繁體中文(香港) 繁體中文(台灣)