OpenAPI 편집기 및 테스트 도구

OpenAPI 도구들

`OpenAPI 사양(OAS)은 웹 API를 특정 프로그래밍 언어에 구애받지 않는 형식으로 설명하는 표준입니다. 이는 소프트웨어 애플리케이션이 인터넷을 통해 어떻게 통신하는지에 대한 청사진을 제공합니다. 개발자는 OpenAPI를 사용하여 API의 세부 정보, 엔드포인트, 데이터 및 보안 관련 사항을 설명하는 JSON 또는 YAML 형식의 지침을 작성합니다. 이러한 표준화된 설명은 다른 프로그램이 API의 내부 코드를 보지 않고도 API와 상호 작용할 수 있도록 합니다.

XMLSpy는 개발 또는 분석 과정에서 OpenAPI를 활용할 수 있도록 다양한 기능을 제공하며, 여기에는 유효성 검사, 편집, 테스트 도구가 포함됩니다.

OpenAPI 문서 편집하기

JSON 또는 YAML 형식으로 작성된 OpenAPI 문서를 다루든, XMLSpy에 내장된 텍스트 기반 OpenAPI 편집기는 구문 강조, 코드 접기, 자동 완성, 항목 도움말 등과 같은 지능적인 편집 기능을 제공합니다.

"표 형식 보기로 전환하면 XMLSpy는 문서 구조를 시각적으로 표현하여 탐색, 이해 및 편집을 용이하게 합니다. 지능적인 편집 도구 외에도, 표 형식 보기는 셀 내 명령, 시각적인 드래그 앤 드롭 편집 기능, 그리고 노드 표시 방식을 재구성할 수 있는 테이블 보기 기능을 제공합니다. 또한, 긴 파일을 탐색하고 특정 요소를 찾기 위해 데이터의 섹션을 확장하거나 축소할 수 있습니다.

텍스트 보기와 그리드 보기 모두 OpenAPI 사양에 따른 문서 유효성 검사를 제공합니다.

XMLSpy를 처음 사용할 때, 새로운 OpenAPI 문서를 생성하기 위한 내장 템플릿이 제공되며, Open API 2.0, 3.0, 3.1, 및 3.2 버전을 지원합니다.

XMLSpy에는 OpenAPI를 지원하는 유용한 HTTP 테스트 창이 포함되어 있습니다. 이 창은 기존 API에 HTTP 요청을 생성하고 전송하는 과정을 안내합니다. 그런 다음, 창 내에서 직접 응답을 수신하고, 확인하며, 문제 해결을 할 수 있습니다.

XMLSpy는 사용자가 설정한 테스트 조건 및 파라미터에 따라 테스트 메시지를 자동으로 생성합니다. 생성된 메시지를 API로 전송한 후, 결과를 확인할 수 있습니다.

편집 중인 OpenAPI 파일을 통해 직접 요청을 생성할 수도 있습니다. 원하는 작업 항목을 마우스 오른쪽 버튼으로 클릭하면 XMLSpy가 해당 작업의 경로, 메서드, 매개변수 및 요청 본문을 읽어 HTTP 테스트 창에 바로 전송할 수 있는 요청을 표시합니다.

테스트는 일반적인 API가 처리하는 모든 요청 유형을 포함하며, 여기에는 파일 업로드 및 혼합 콘텐츠를 위한 `multipart/form-data 요청도 포함됩니다. 작업에서 multipart 형식의 데이터가 필요할 경우, XMLSpy는 OpenAPI 정의를 기반으로 해당 데이터의 각 부분을 미리 채워줍니다. 따라서 사용자는 값과 파일 경로만 입력하면 바로 전송할 수 있습니다.

요청을 보내고 응답을 확인하는 기능은 API가 개발 및 통합 과정에서 예상대로 작동하는지 확인하는 데 도움이 됩니다. 이 기능은 자체 API를 테스트하는 데 유용할 뿐만 아니라, 외부 API 인터페이스를 탐색하는 데에도 효과적인 도구입니다.