አሁንም በማሽን-ሊነበብ ለሚችል API ዝርዝር መግለጫዎች የማትጠቀሙ ከሆነ እንደ OpenAPI (የቀድሞ ስሙ ስዋገር) በእርግጠኝነት ይህን ለማድረግ ማሰብ አለብዎት። ለነገሩ ኤፒአይዎች ለማሽኖች የሚነጋገሩበት ቋንቋዎች ናቸው።
ስዋገር ጥሩ ሀሳብ ነው?
Swagger በጣም ጥሩ የሆነ የመጀመሪያ ስሜት ይፈጥራል ከዚህም በተጨማሪ ብዙ ሰዎች ከሰነዱ ውስጥ ኮድ የማውጣት እድሉ ጥሩ ነው ብለው ያስባሉ እና ስዋገር ይህንን ያቀርባል እንዲሁም. ስለዚህ ስዋገር ጥሩ የመጀመሪያ ስሜት ይፈጥራል፣ ውስንነቱን እና ገደቦቹን ያነሰ ግልጽ ያደርገዋል።
ስዋገርን የመጠቀም አላማ ምንድነው?
Swagger ማሽኖች እንዲያነቧቸው የእርስዎን ኤፒአይዎች አወቃቀር እንዲገልጹ ያስችልዎታል። የኤፒአይዎች የየራሳቸውን መዋቅር የመግለጽ ችሎታ በስዋገር ውስጥ የሁሉም አስደናቂነት መነሻ ነው።
ስዋገር አሁንም ጥቅም ላይ ይውላል?
ዛሬ፣ ብዙ ተጠቃሚዎች የOpenAPI 2.0 Specification ቅርጸት ን ለመጥቀስ "Swagger" የሚሉትን ቃላት እና "Swagger spec" በዚህ ቅርጸት የኤፒአይ መግለጫ ሰነድን ይጠቀማሉ።. RepreZen API Studio እነዚህን ቃላት በአንዳንድ የዩአይኤ ክፍሎች ይጠቀማል ነገር ግን OpenAPI 3.0 እና በኋላ ስሪቶችን እንደ "OpenAPI" ይጠቅሳል።
ስዋገር ለREST API ብቻ ነው?
OpenAPI Specification (የቀድሞው ስዋገር መግለጫ) የኤፒአይ መግለጫ ቅርጸት ለREST APIs ነው። የOpenAPI ፋይል የሚከተሉትን ጨምሮ ሁሉንም የእርስዎን ኤፒአይ እንዲገልጹ ይፈቅድልዎታል፡ የሚገኙ የመጨረሻ ነጥቦች (/ተጠቃሚዎች) እና በእያንዳንዱ የመጨረሻ ነጥብ (GET/ተጠቃሚዎች፣ POST/ተጠቃሚዎች)