LabCollector  گزینه های مختلف تنظیم را ارائه می دهد. آماده استفاده است (تا جایی که ممکن است)، پیکربندی آن را می توان به راحتی توسط سوپر ادمین به منظور برآوردن نیازهای آزمایشگاهی خاص شما. به عنوان بخشی از این، LabCollector فراهم می کند رابط کاربری Swagger که شما را قادر می سازد تا کاوش و آزمایش کنید REST API.

سوگگر یک رابط مبتنی بر وب است که روشی کاربرپسند برای تعامل با API ارائه می دهد. این به کاربران اجازه می دهد تا نقاط پایانی API موجود، پارامترهای آنها و پاسخ هایی را که برمی گردانند مشاهده کنند. کاربران همچنین می توانند درخواست هایی را به API ارسال کنند و پاسخ ها را در آن مشاهده کنند زمان واقعی.

در پایگاه دانش زیر، نحوه استفاده از آن را به شما آموزش خواهیم داد LabCollectorSwagger، همچنین نحوه دسترسی به Swagger UI، نحوه کاوش و آزمایش نقاط پایانی API موجود، و نحوه تولید اسناد به طور خودکار بر اساس مشخصات OpenAPI را پوشش خواهیم داد.

1. چگونه می توانم دسترسی داشته باشم LabCollectorسواگر است؟

2. چگونه نقاط پایانی API را آزمایش کنیم؟

1. چگونه می توانم دسترسی داشته باشم LabCollectorسواگر است؟

برای پیکربندی API خدمات وب خود، به سادگی به ADMIN -> OTHER -> SETUP -> API خدمات وب:

• طیف جدیدی از برنامه های کاربردی بر اساس شما LabCollector نمونه قابل اجرا و توسعه است.
• با استفاده از LabCollector به عنوان یک پایگاه داده پشتیبان، آزمایشگاه می تواند اطلاعات از راه دور را در کاتالوگ های خارجی، منابع بیولوژیکی و غیره ارائه دهد.
  
• LabCollector خدمات API را به شما ارائه می دهد که می تواند به شما کمک کند یک برنامه شخص ثالث را به آن متصل کنید LabCollector.

           * برای اطلاعات بیشتر به این مطلب مراجعه فرمایید KB.

با کلیک بر روی نماد نارنجی به راحتی می توان به Swagger دسترسی پیدا کرد در سمت راست برنامه ای که می خواهید ادغام کنید (همانطور که در تصویر زیر نشان داده شده است) قرار دارد.

هنگامی که روی نماد Swagger مربوطه کلیک کردید، یک پنجره جدید ظاهر می شود که پیام "ایجاد swagger ممکن است چند ثانیه طول بکشد". از آنجایی که تولید مشخصات OpenAPI بسته به پیچیدگی خود API ممکن است مدتی طول بکشد. پس از آماده شدن، به سادگی بر روی “کلیک کنیدSwagger را برای این برنامه ایجاد کنید” برای دسترسی به رابط کاربری Swagger.

اگر قبلاً یک Swagger برای یک برنامه ایجاد کرده‌اید، با کلیک بر روی نماد Swagger پنجره‌ای باز می‌شود که به شما این امکان را می‌دهد که Swagger فعلی را نشان دهید یا آن را برای ایجاد یک برنامه جدید بازخوانی کنید. این به ویژه در صورتی مفید است که تغییراتی در API از آخرین باری که Swagger ایجاد شده است، ایجاد شده باشد.

همچنین آخرین باری که Swagger به‌روزرسانی شده است را نمایش می‌دهد که به شما کمک می‌کند اعتبار Swagger را پیگیری کنید و به‌ویژه برای APIهای بزرگی که مرتباً به‌روزرسانی می‌شوند مفید باشد.

به عنوان مثال، فرض کنید تغییراتی در خود ایجاد کرده اید LabCollector نقاط پایانی API، مانند افزودن یا اصلاح پارامترها، و می‌خواهید مطمئن شوید که Swagger به‌طور دقیق این تغییرات را منعکس می‌کند. در این صورت، می توانید به سادگی Swagger را با کلیک بر روی دکمه refresh refresh کنید و یک Swagger جدید با اطلاعات به روز شده ایجاد می شود.

1. چگونه نقاط پایانی API را آزمایش کنیم؟

هنگامی که یک Swagger برای برنامه انتخابی خود ایجاد کردید، به طور خودکار به رابط کاربری Swagger UI هدایت می شوید، که لیستی از نقاط پایانی API موجود را در سمت چپ صفحه نمایش می دهد (همانطور که در تصویر زیر نشان داده شده است). این رابط کاربر پسند به شما امکان می دهد به راحتی قابلیت های API را بررسی کنید، آن را آزمایش کنید و مستنداتی را بر اساس مشخصات OpenAPI ایجاد کنید.

سپس، روی یک نقطه پایانی کلیک کنید تا جزئیات آن، از جمله پارامترهای آن و پاسخ‌هایی را که برمی‌گرداند، مشاهده کنید، در مثال ما، می‌توانیم تمام ماژول‌ها و نقاط پایانی مربوط به آن‌ها را به همراه شرح مختصری از عملکردشان ببینیم. به عنوان مثال، ما می توانیم آن را ببینیم GET/ سویه ها روی گرفتن رکورد از ماژول Strains & Cells کار می کند، POST/ سویه ها روی اضافه کردن رکوردها به همان ماژول کار می کند ... و غیره.

برای آزمایش نقطه پایانی، روی “امتحانش کن” را فشار دهید و پارامترهای مورد نیاز را وارد کنید (همانطور که در تصویر زیر نشان داده شده است). این به ویژه هنگام توسعه و آزمایش نقاط پایانی جدید قبل از ادغام آنها در برنامه شما مفید است.

در نهایت، پس از وارد کردن تمام پارامترهای خود، روی "کلیک کنید.اجرا کردندکمه ” برای ارسال درخواست به API و مشاهده پاسخ.

سپس می توانید نتیجه درخواست خود را در کنار تمام درخواست های بد / غیر مجاز / ممنوع در صورت وجود مشاهده کنید.

علاوه بر این، Swagger UI به شما امکان می دهد اسناد را به طور خودکار بر اساس مشخصات OpenAPI ایجاد کنید. این مستندات را می توان در فرمت های مختلفی مانند PDF یا JSON دانلود کرد و می توان از آن برای انتقال قابلیت های API به دیگر توسعه دهندگان استفاده کرد.