Swagger UI란 무엇입니까? API 엔드포인트에 액세스하고 테스트하는 방법은 무엇입니까? - LabCollector

키워드로 기술 자료 검색

현재 위치 :
→ 모든 주제

LabCollector  다양한 설정 옵션을 제공합니다. 바로 사용할 수 있습니다. (가능한 한) 해당 구성은 다음을 통해 쉽게 관리할 수 있습니다. 최고 관리자 특정 실험실 요구 사항을 충족하기 위해. 이것의 일환으로, LabCollector 를 제공합니다 스웨거 UI 이를 통해 탐색하고 테스트할 수 있습니다. REST API.

멋진 API와 상호 작용할 수 있는 사용자 친화적인 방법을 제공하는 웹 기반 인터페이스입니다. 이를 통해 사용자는 사용 가능한 API 엔드포인트, 해당 매개변수 및 반환되는 응답을 볼 수 있습니다. 사용자는 API에 요청을 보내고 다음에서 응답을 볼 수도 있습니다. 실시간.

다음 기술 자료에서는 사용 방법을 안내합니다. LabCollector의 Swagger에서는 Swagger UI에 액세스하는 방법, 사용 가능한 API 엔드포인트를 탐색 및 테스트하는 방법, OpenAPI 사양을 기반으로 문서를 자동으로 생성하는 방법도 다룹니다.

1. 어떻게 접속하나요? LabCollector스웨거?

2. API 엔드포인트를 테스트하는 방법은 무엇입니까?

1. 어떻게 접속하나요? LabCollector스웨거?

웹 서비스 API를 구성하려면 다음으로 이동하세요. 관리자 -> 기타 -> 설정 -> 웹 서비스 API:

  • 귀하의 기반을 바탕으로 한 새로운 응용 범위 LabCollector 인스턴스를 구현하고 개발할 수 있습니다.
  • 사용 LabCollector 백엔드 데이터베이스로서 실험실은 외부 카탈로그, 생물 자원 등에 대한 원격 정보를 제공할 수 있습니다.
  • LabCollector 타사 애플리케이션을 연결하는 데 도움이 되는 API 서비스를 제공합니다. LabCollector.

           * 자세한 내용은 이것을 참조하십시오 KB.

주황색 아이콘을 클릭하면 Swagger에 쉽게 액세스할 수 있습니다. 통합하려는 애플리케이션 오른쪽에 있습니다(아래 스크린샷 참조).

해당 Swagger 아이콘을 클릭하면 "라는 메시지를 표시하는 새 팝업이 나타납니다.Swagger를 생성하는 데 몇 초가 걸릴 수 있습니다.“. OpenAPI 사양을 생성하는 데는 API 자체의 복잡성에 따라 다소 시간이 걸릴 수 있습니다. 준비가 되면 '를 클릭하세요.이 앱에 대한 Swagger 만들기'를 클릭하여 Swagger UI에 액세스합니다.

이전에 앱용 Swagger를 생성한 경우 Swagger 아이콘을 클릭하면 현재 Swagger를 표시하거나 새로 고쳐 새 Swagger를 생성할 수 있는 옵션을 제공하는 팝업이 열립니다. 이는 Swagger가 마지막으로 생성된 이후 API가 변경된 경우 특히 유용합니다.

팝업에는 Swagger가 마지막으로 업데이트된 시간도 표시됩니다. 이는 Swagger의 유효성을 추적하는 데 도움이 되며 자주 업데이트되는 대규모 API에 특히 유용할 수 있습니다.

예를 들어, LabCollector 매개변수 추가 또는 수정과 같은 API 엔드포인트와 Swagger가 이러한 변경 사항을 정확하게 반영하는지 확인하려고 합니다. 이 경우 새로 고침 버튼을 클릭하여 Swagger를 새로 고치면 업데이트된 정보로 새로운 Swagger가 생성됩니다.

1. API 엔드포인트를 테스트하는 방법은 무엇입니까?

선택한 앱에 대한 Swagger를 생성하면 자동으로 Swagger UI 인터페이스로 리디렉션됩니다. 이 인터페이스는 화면 왼쪽에 사용 가능한 API 엔드포인트 목록을 표시합니다(아래 스크린샷 참조). 이 사용자 친화적인 인터페이스를 사용하면 API 기능을 쉽게 탐색하고, 테스트하고, OpenAPI 사양을 기반으로 문서를 생성할 수 있습니다.

그런 다음 엔드포인트를 클릭하면 해당 매개변수 및 반환되는 응답을 포함한 세부 정보를 볼 수 있습니다. 이 예에서는 해당 작업에 대한 간략한 설명과 함께 모든 모듈과 해당 엔드포인트를 볼 수 있습니다. 예를 들어, 우리는 다음을 볼 수 있습니다 GET/균주 Strains & Cells 모듈에서 레코드를 가져오는 작업을 수행합니다. POST/균주 동일한 모듈에 레코드를 추가하는 작업을 수행합니다.

엔드포인트를 테스트하려면 '그것을 밖으로 시도하십시오” 버튼을 클릭하고 필수 매개변수를 입력합니다(아래 스크린샷 참조). 이는 새로운 엔드포인트를 애플리케이션에 통합하기 전에 개발하고 테스트할 때 특히 유용합니다.

마지막으로 모든 매개변수를 입력한 후 '실행하다” 버튼을 눌러 API에 요청을 보내고 응답을 확인하세요.

그런 다음 모든 잘못된/무단/금지된 요청과 함께 요청 결과를 확인할 수 있습니다.

또한 Swagger UI를 사용하면 OpenAPI 사양을 기반으로 문서를 자동으로 생성할 수 있습니다. 이 문서는 PDF 또는 JSON과 같은 다양한 형식으로 다운로드할 수 있으며 API 기능을 다른 개발자에게 전달하는 데 사용할 수 있습니다.

주의 사항
사용법 - LabCollector Swagger UI를 사용하면 사용 가능한 API 엔드포인트를 탐색하고 코드를 작성하지 않고도 해당 기능을 테스트할 수 있습니다.. 이를 통해 API 작동 방식을 쉽게 이해하고 통합하는 데 도움이 됩니다. LabCollector 다른 시스템과.

관련 주제 :