LabCollector  предлага различни опции за настройка. Готов е за употреба (доколкото е възможно), неговата конфигурация може лесно да се управлява от Супер-админ за да отговори на вашите специфични лабораторни изисквания. Като част от това, LabCollector осигурява Потребителски интерфейс на Swagger което ви позволява да изследвате и тествате REST API.

перчене е уеб базиран интерфейс, който предоставя удобен за потребителя начин за взаимодействие с API. Той позволява на потребителите да преглеждат наличните крайни точки на API, техните параметри и отговорите, които връщат. Потребителите могат също да изпращат заявки до API и да преглеждат отговорите в в реално време.

В следващата База знания ще ви преведем как да използвате LabCollectorSwagger, ние също ще разгледаме как да получите достъп до потребителския интерфейс на Swagger, как да изследвате и тествате наличните крайни точки на API и как да генерирате документация автоматично въз основа на спецификацията на OpenAPI.

1. Как мога да получа достъп LabCollectorе Суагър?

2. Как да тествате крайни точки на API?

1. Как мога да получа достъп LabCollectorе Суагър?

За да конфигурирате вашия API за уеб услуги, просто отидете на АДМИНИСТРАТОР -> ДРУГИ -> НАСТРОЙКА -> API за уеб услуги:

• Нова гама от приложения, базирани на вашите LabCollector екземпляр може да бъде внедрен и разработен.
• Използването на LabCollector като бекенд база данни, лабораторията може да предоставя отдалечена информация във външни каталози, биологични ресурси и др.
  
• LabCollector ви предлага API услуги, които могат да ви помогнат да свържете приложение на трета страна към LabCollector.

           * За повече информация, моля, вижте това KB.

Swagger може да бъде лесно достъпен чрез щракване върху оранжевата икона разположен вдясно от приложението, което искате да интегрирате (както е показано на екранната снимка по-долу).

След като щракнете върху съответната икона на Swagger, ще се появи нов изскачащ прозорец, показващ съобщението „Генерирането на перчене може да отнеме няколко секунди“. Тъй като генерирането на спецификацията на OpenAPI може да отнеме известно време в зависимост от сложността на самия API. След като сте готови, просто щракнете върху „Създайте Swagger за това приложение” за достъп до потребителския интерфейс на Swagger.

Ако преди това сте създали Swagger за приложение, щракването върху иконата Swagger ще отвори изскачащ прозорец, който ви дава опцията да покажете текущия Swagger или да го опресните, за да генерирате нов. Това е особено полезно, ако са направени промени в API след последното генериране на Swagger.

Изскачащият прозорец също така показва последния път, когато Swagger е актуализиран, което ви помага да следите валидността на Swagger и може да бъде особено полезно за големи API, които се актуализират често.

Да предположим например, че сте направили някои промени във вашия LabCollector API крайни точки, като добавяне или модифициране на параметри, и искате да сте сигурни, че Swagger отразява точно тези промени. В такъв случай можете просто да опресните Swagger, като щракнете върху бутона за опресняване и ще бъде генериран нов Swagger с актуализираната информация.

1. Как да тествате крайни точки на API?

След като създадете Swagger за избраното от вас приложение, ще бъдете автоматично пренасочени към потребителския интерфейс на Swagger, който показва списък с налични крайни точки на API в лявата част на екрана (както е показано на екранната снимка по-долу). Този удобен за потребителя интерфейс ви позволява лесно да изследвате възможностите на API, да го тествате и да генерирате документация въз основа на спецификацията на OpenAPI.

След това щракнете върху крайна точка, за да видите нейните подробности, включително нейните параметри и отговорите, които връща. В нашия пример можем да видим всички модули и съответните им крайни точки, заедно с кратко описание на тяхното действие. Например, можем да видим това GET/щамове работи по получаване на записи от модула Щамове и клетки, POST/щамове работи по добавяне на записи към същия модул... и т.н.

За да тествате крайна точка, щракнете върху „Опитай го” и въведете необходимите параметри (както е показано на екранната снимка по-долу). Това е особено полезно при разработване и тестване на нови крайни точки, преди да ги интегрирате във вашето приложение.

Накрая, след като сте въвели всичките си параметри, щракнете върху „Изпълнение”, за да изпратите заявката до API и да видите отговора.

След това можете да видите резултата от вашата заявка, заедно с всички лоши / неразрешени / забранени заявки, ако има такива.

Освен това потребителският интерфейс на Swagger ви позволява автоматично да генерирате документация въз основа на спецификацията на OpenAPI. Тази документация може да бъде изтеглена в различни формати, като PDF или JSON, и може да се използва за съобщаване на възможностите на API на други разработчици.