LabCollector  nabízí různé možnosti nastavení. Je připraven k použití (pokud je to možné), jeho konfiguraci lze snadno spravovat pomocí Superadministrátor tak, aby vyhovovaly vašim specifickým laboratorním požadavkům. V rámci toho LabCollector poskytuje Uživatelské rozhraní Swagger která vám umožní prozkoumat a otestovat REST API.

Naparování je webové rozhraní, které poskytuje uživatelsky přívětivý způsob interakce s API. Umožňuje uživatelům zobrazit dostupné koncové body API, jejich parametry a odpovědi, které vracejí. Uživatelé mohou také odesílat požadavky do rozhraní API a prohlížet si odpovědi v v reálném čase.

V následující databázi znalostí vás provedeme tím, jak používat LabCollector's Swagger se také budeme zabývat tím, jak přistupovat k uživatelskému rozhraní Swagger, jak prozkoumávat a testovat dostupné koncové body API a jak automaticky generovat dokumentaci na základě specifikace OpenAPI.

1. Jak mohu získat přístup? LabCollectorje Swagger?

2. Jak otestovat koncové body API?

1. Jak mohu získat přístup? LabCollectorje Swagger?

Chcete-li nakonfigurovat rozhraní API webových služeb, přejděte na adresu ADMIN -> JINÉ -> NASTAVENÍ -> API webových služeb:

• Nová řada aplikací na základě vašeho LabCollector instance lze implementovat a rozvíjet.
• Použití LabCollector jako backendová databáze může laboratoř poskytovat vzdálené informace v externích katalozích, biologických zdrojích atd.
  
• LabCollector vám nabízí služby API, které vám mohou pomoci připojit aplikaci třetí strany LabCollector.

           * Další informace naleznete zde KB.

Swagger je snadno přístupný kliknutím na oranžovou ikonu umístěný napravo od aplikace, kterou chcete integrovat (jak je znázorněno na obrázku níže).

Jakmile kliknete na odpovídající ikonu Swagger, objeví se nové vyskakovací okno se zprávou „Generování chvástání může trvat několik sekund“. Protože generování specifikace OpenAPI může nějakou dobu trvat v závislosti na složitosti samotného API. Jakmile budete připraveni, jednoduše klikněte na „Vytvořte Swagger pro tuto aplikaci” pro přístup k uživatelskému rozhraní Swagger.

Pokud jste dříve vytvořili Swagger pro aplikaci, kliknutím na ikonu Swagger se otevře vyskakovací okno, které vám dá možnost buď zobrazit aktuální Swagger, nebo jej obnovit a vygenerovat nový. To je zvláště užitečné, pokud byly v API provedeny změny od posledního vygenerování Swaggeru.

Vyskakovací okno také zobrazuje, kdy byl Swagger naposledy aktualizován, což vám pomůže sledovat platnost Swagger a může být užitečné zejména pro velká API, která jsou často aktualizována.

Předpokládejme například, že jste provedli nějaké změny ve svém LabCollector Koncové body rozhraní API, jako je přidávání nebo úprava parametrů, a chcete zajistit, aby Swagger tyto změny přesně odrážel. V takovém případě můžete jednoduše aktualizovat Swagger kliknutím na tlačítko refresh a vygeneruje se nový Swagger s aktualizovanými informacemi.

1. Jak otestovat koncové body API?

Jakmile vytvoříte Swagger pro vybranou aplikaci, budete automaticky přesměrováni do rozhraní Swagger UI, které zobrazuje seznam dostupných koncových bodů API na levé straně obrazovky (jak je znázorněno na obrázku níže). Toto uživatelsky přívětivé rozhraní vám umožňuje snadno prozkoumat možnosti API, testovat je a vytvářet dokumentaci na základě specifikace OpenAPI.

Poté kliknutím na koncový bod zobrazíte jeho podrobnosti, včetně jeho parametrů a odpovědí, které vrací. V našem příkladu můžeme vidět všechny moduly a jejich odpovídající koncové body spolu se stručným popisem jejich akce. Například to můžeme vidět GET/kmeny pracuje na získávání záznamů z modulu Strains & Cells, POST/kmeny funguje na přidávání záznamů do stejného modulu… atd.

Chcete-li otestovat koncový bod, klikněte na „Vyzkoušej to” a zadejte požadované parametry (jak je znázorněno na obrázku níže). To je užitečné zejména při vývoji a testování nových koncových bodů před jejich integrací do vaší aplikace.

Nakonec, jakmile zadáte všechny své parametry, klikněte na „Provést” pro odeslání požadavku do API a zobrazení odpovědi.

Poté můžete vidět výsledek svého požadavku spolu se všemi špatnými / neoprávněnými / zakázanými požadavky, pokud nějaké byly.

Kromě toho vám uživatelské rozhraní Swagger umožňuje generovat dokumentaci automaticky na základě specifikace OpenAPI. Tuto dokumentaci lze stáhnout v různých formátech, jako je PDF nebo JSON, a lze ji použít ke sdělování možností rozhraní API dalším vývojářům.