Postman은 REST API를 다루기 위한 범용 도구입니다. API를 생성하고, 테스트하고, 문서화하며, 공유하는 데 도움을 줍니다. 아래는 Postman이 제공하는 주요 기능입니다.
- API 요청 생성: Postman은 HTTP 및 HTTPS 기반의 API 요청을 쉽게 생성할 수 있으며, GET, POST, PUT, DELETE와 같은 다양한 HTTP 메서드를 지원합니다. 또한 Header, Body 등 요청 파라미터를 손쉽게 설정할 수 있습니다.
- 요청 컬렉션(Collections): 사용자는 API 요청을 컬렉션으로 구성하여 정리할 수 있으며, 프로젝트 또는 특정 API 단위로 체계적으로 관리할 수 있습니다.
- 환경 변수 및 스크립트: Postman은 환경 변수를 활용하여 동적인 요청을 구성할 수 있고, JavaScript 기반 스크립팅 인터페이스를 제공하여 작업 자동화도 가능합니다.
- 테스트 및 자동화: API 응답을 검증하기 위한 테스트 스크립트를 작성하고 실행할 수 있어, 응답의 정확성을 확인하고 자동화 테스트를 수행하는 데 유용합니다.
- 실시간 협업 및 공유: 여러 사용자가 API 요청, 환경 설정, 컬렉션 등을 실시간으로 공유할 수 있어, 협업 기반 개발에 도움이 됩니다.
Postman은 무료 버전과 유료 버전(Pro 및 Enterprise)을 제공하며, 유료 버전에서는 더 향상된 기능과 협업 도구를 사용할 수 있습니다. Postman은 개발자, 테스트 엔지니어, 기업 등 다양한 사용자층에서 널리 활용되며, API 개발, 테스트, 관리를 보다 간편하게 만들어 줍니다.
Postman으로 MIDAS API 사용하기
Postman 설치 및 사용 방법을 자세히 이해하려면 공식 웹사이트를 참고하시기 바랍니다.
Download Postman | Get Started for Free
이제 Postman을 사용하여 CIVIL Open API를 사용하는 방법을 안내하겠습니다.
- CIVIL NX를 실행하고 새 파일을 만든 뒤, 서버에 연결합니다. (Apps → Connect)
CIVIL NX
- 설치된 Postman을 실행합니다.
프로그램 실행 화면
- REST API를 사용하려면 먼저 Collection을 생성해야 합니다. (폴더와 유사한 개념)
Collection 생성
- 새로 생성한 Collection을 클릭하고, 오른쪽의 점 3개 메뉴를 선택한 뒤 Add Request를 클릭합니다.
Collection에 Request 추가
- REST API 요청을 보낼 수 있는 창이 생성되었습니다. 각 항목은 다음과 같은 역할을 합니다.
① HTTP METHOD를 설정합니다. (GET, POST, PUT, DELETE)
② 요청할 URL을 입력합니다.
③ Header와 Body를 설정합니다.
④ 요청을 실행합니다.
⑤ 서버로부터 받은 응답을 표시합니다.
Request
- CIVIL NX에서 새로 연 파일의 “UNIT” 정보를 조회합니다.
① HTTP METHOD
이 작업은 정보를 “조회(READ)”하는 것이므로, 아래와 같이 HTTP METHOD를 “GET”으로 설정합니다.
HTTP METHOD
② URL
제품에서 base URL을 확인한 뒤 복사합니다. (Apps → API → API Settings)
CIVIL NX - API Settings
복사한 Base URL을 입력 창에 붙여넣고, 아래와 같이 접근하려는 데이터 URL을 이어서 입력합니다.
③ Header 및 Body 설정
Header에는 기본적으로 자동 생성된 데이터가 있으며, 별도의 수정은 필요하지 않습니다.
Header
아래와 같이 헤더를 추가합니다.
- Key → MAPI-Key 입력
- Value → 위 ②의 그림과 같이 제품에서 복사하여 붙여넣기
MAPI-Key 입력
“GET” 및 “DELETE” 메서드의 경우 Body는 필요하지 않습니다.
④ UNIT 정보를 조회할 준비가 완료되었습니다. “Send”를 클릭합니다.
⑤ Response 창을 확인합니다.
Body에는 조회된 JSON 데이터가 읽기 쉬운 형태로 표시됩니다. 우측 상단에는 HTTP 코드, 응답 시간, 데이터 크기가 표시됩니다.
API를 통해 획득한 정보가 실제 제품의 정보와 일치하는지 확인합니다.
- CIVIL NX의 새 파일에서 “UNIT” 정보를 수정합니다.
HTTP Method → PUT
URL → 동일
Header → 동일
Body
생성(POST) 및 수정(PUT) 요청의 경우, 요청과 함께 해당 JSON 데이터를 반드시 전송해야 합니다.
Body 탭으로 이동하여 raw를 선택한 뒤 JSON 형식을 선택합니다. (아래 이미지 참고)
JSON 데이터를 이용하여 FORCE를 KN으로, 온도 단위를 Fahrenheit로 수정합니다. 아래 데이터를 복사하여 요청 Body에 붙여넣습니다.
{
"Assign": {
"1": {
"FORCE": "KN",
"DIST": "M",
"HEAT": "KCAL",
"TEMPER": "F"
}
}
} CIVIL NX의 데이터가 변경되었는지 확인하기 위해 "Send"를 클릭합니다.
쉽게 사용할 수 있음
Postman은 사용자 친화적인 인터페이스를 제공하며, 별도의 프로그래밍 없이도 REST API를 다룰 수 있어 API를 빠르게 테스트하고 확인하는 데 가장 손쉬운 방법 중 하나입니다.
유효하지 않은 JSON 형식
또한 Body 영역에서 JSON 형식에 대한 문법 검증, 복잡한 JSON 구조의 자동 정렬(Beautify)과 같은 기능을 제공하여 요청 내용을 확인하고 전송하기에 편리합니다.
JSON 형식 정렬(Beautify)
Postman과 같은 도구를 통해 MIDAS Open API를 직접 다뤄보는 경험은, 기능과 활용 가능성을 더 잘 이해할 수 있는 좋은 기회가 될 수 있습니다. 실제로 API와 상호작용해 보면서, 기능을 보다 쉽게 이해하고 활용할 수 있습니다.