مشخصات OpenAPI به طور گسترده برای تعریف API های RESTful استفاده می شود. یکی از اجزای حیاتی مشخصات OpenAPI، بخش سرور است که لیستی از URL هایی را که می توان به API دسترسی داشت، ارائه می دهد. با این حال، کار با بخش سرور می تواند پیچیده باشد، به خصوص زمانی که URL های سرور حاوی متغیرها و سایر اجزای پویا هستند. آنجاست openapi-url-resolver جلو می آید.
در زیر یک مثال شی سرور آورده شده است،
{
"servers": [
{
"url": "https://{username}.gigantic-server.com:{port}/{basePath}",
"description": "The production API server",
"variables": {
"username": {
"default": "demo",
"description": "this value is assigned by the service provider, in this example `gigantic-server.com`"
},
"port": {
"enum": [
"8443",
"443"
],
"default": "8443"
},
"basePath": {
"default": "v2"
}
}
}
]
}
URL ها یا میزبان های سرور را از تعاریف OpenAPI 3.x حل کنید
openapi-url-resolver یک بسته NPM سبک وزن است که فرآیند حل و فصل URL های سرور را از مشخصات OpenAPI ساده می کند. با openapi-url-resolver، می توانید به راحتی اطلاعات سرور را استخراج کنید و پروتکل ها را از URL های حل شده حذف کنید و کار با API هایی را که با مشخصات OpenAPI مطابقت دارند آسان تر می کند.
در اینجا برخی از ویژگی های کلیدی openapi-url-resolver آورده شده است:
- 📦 سبک وزن ماژول با اندازه تنها 965 بایت
- 🚀 وابستگی صفر، نصب و استفاده از آن را در پروژه های خود آسان می کند
- 🎯 راه کارآمد و ساده برای حل کردن URL ها از مشخصات OpenAPI
می توانید نصب کنید openapi-url-resolver از طریق NPM:
npm install openapi-url-resolver
استفاده از openapi-url-resolver ساده است. تنها کاری که باید انجام دهید این است که یک شیء مشخصات OpenAPI 3.x را به آن ارسال کنید resolve() تابع، و آرایه ای از URL های سرور حل شده را برمی گرداند. همچنین می توانید پارامتر دوم را به آن ارسال کنید resolve() عملکرد دریافت URL های سرور با پروتکل ها.
در اینجا مثالی از نحوه استفاده از openapi-url-resolver آورده شده است:
این یک ابزار عالی برای توسعه دهندگانی است که نیاز به استخراج اطلاعات سرور از مشخصات OpenAPI دارند. این سبک وزن است، استفاده از آن آسان است و هیچ گونه وابستگی ندارد، و آن را به یک مکمل عالی برای هر پروژه ای که از OpenAPI استفاده می کند تبدیل می کند..
اگر علاقه مند به کسب اطلاعات بیشتر در مورد openapi-url-resolver، مخزن GitHub را بررسی کنید و آن را در پروژه های خود امتحان کنید!
متشکرم.
