Swagger UI는 *REST API 를 쉽게 테스트하고 문서화 할 수 있도록 도와주는 툴입니다.

[Request methods for REST API]

BioStar 2 서버가 설치된 로컬 PC에 BioStar 2 API 서버를 설치 한 뒤 로컬 API를 사용하십시오.
API를 통해 BioStar 2 서버에 메시지를 전송하려면 아래 URL 형식을 사용해야 합니다.
http://127.0.0.1:8795/v2/ [url path displayed API reference]

URL은 BioStar 2 버전에 따라 다릅니다.

• BioStar v2.3 이하 (v1 API) - http://127.0.0.1:8790/v1/docs/
  
• BioStar v2.4 이상 (v2 API) - http://127.0.0.1:8795/v2/docs/
  

Swagger UI를 통해 BioStar 2 API에 대한 정보를 제공하므로, API를 호출하기 전 API의 종류와 모델 스키마(Model Schema)를 확인할 수 있습니다. 다음은 로그인 API를 사용하여 이 툴을 활용하는 방법의 예시입니다.

• POST /login API

1) Parameters 섹션에서 Model Schema에 대한 노란색 박스를 클릭하십시오. 박스의 내용이 복사되어 동일한 섹션의 Value(흰색 박스)에 붙여 넣어집니다.
2) BioStar 2에 로그인하기 위해 흰색 박스에 값을 입력하십시오.
3) 응답 메시지에 대한 결과를 확인하려면 Try it out 버튼을 클릭하십시오.

Postman은 API 호출 결과를 쉽게 확인할 수 있는 Chrome 앱입니다. Postman을 사용하면 복잡한 HTTP 요청을 빠르게 처리하고 수집하여 정리한 뒤 동료들과 공유할 수 있습니다. 가장 큰 장점은 API를 호출한 기록이 남는다는 것입니다.

Postman은 Chrome 웹 스토어에서 내려받을 수 있습니다.
https://chrome.google.com/webstore/search/Postman?hl=ko

• POST /login API

Swagger UI에서
1) Parameters 섹션에서 Model Schema에 대한 노란색 박스를 클릭하십시오. 박스의 내용이 복사되어 동일한 섹션의 Value(흰색 박스)에 붙여 넣어집니다.
2) 흰색 박스에 표시된 모든 데이터를 복사하십시오.

Postman에서
3) 드롭 박스에서 POST를 선택한 뒤 로그인 API를 호출할 URL을 입력하십시오. 로컬 API의 경우, “http://127.0.0.1:8795/v2/login“와 같이 URL을 입력하십시오.
4) 아래 표시한 초록색 박스와 같이 Body, raw, JSON(application/json)을 선택하십시오.
5) Swagger UI에서 복사한 데이터를 Postman에 붙여 넣으십시오.
6) Send 버튼을 클릭하십시오.
7) 응답 결과가 섹션 하단에 표시됩니다.

• GET /login API

Swagger UI에서
1) Parameters 섹션에서 Parameter를 확인하십시오. limit과 offset은 모두 URL Parameters와 같이 필수입니다.

Postman에서
2) 드롭 박스에서 GET을 선택한 뒤 로그인 API를 호출할 URL을 입력하십시오. GET 메시지의 경우 URL에서 필요한 Parameters를 사용해야 합니다. 로컬 API의 경우 “http://127.0.0.1:8795/v2/users/limit=5&offset=0“과 같이 URL을 입력하십시오.

3) Send 버튼을 클릭하십시오.
4) 응답 결과가 섹션 하단에 표시됩니다.