본문으로 건너뛰기

View API Settings

API 설정을 보려면 Backend Servers 페이지로 이동합니다. 필요한 API를 찾고 API를 클릭하여 자세한 요약을 엽니다.

팁

검색 및 필터 도구를 사용하여 필요한 API를 빠르게 찾을 수 있습니다.

개요​

개요 탭은 선택한 API에 대한 구성 및 메타데이터를 포함한 주요 세부정보를 제공합니다.

API 정보​

이 섹션은 API를 식별하고 설명하는 일반적인 고급 정보를 포함합니다.

  • Version: API의 특정 릴리스 버전을 나타내며, 의미론적 버전 관리를 따릅니다 (예: v1.0.0). 이는 시간에 따라 업데이트 및 변경 사항을 추적하는 데 도움이 됩니다.
  • Backend System Name: 시스템 내에서 API의 고유한 내부 식별자 또는 코드명입니다 (예: petstorev3).
  • Description: API의 목적, 기반이 되는 사양(예: OpenAPI 3.0), 설계 접근 방식 및 목표를 설명하는 자세한 설명입니다.
  • Label: API를 분류, 필터링 및 조직하는 데 사용되는 키-값 쌍입니다. 이는 사용자 정의 메타데이터를 추가하는 유연한 방법을 제공합니다. API는 다양한 목적을 위해 여러 레이블을 가질 수 있습니다.

백엔드 정보​

이 섹션은 API와 상호작용하는 데 필요한 기술적 엔드포인트 정보를 자세히 설명합니다.

  • Backend ID: API를 지원하는 특정 백엔드 서비스를 식별하는 고유한 시스템 생성 알파벳 숫자 문자열입니다 (예: 68a67d3008c05608c7f1c734).
  • Domain: API가 호스팅되는 기본 웹 주소입니다. 이는 모든 API 호출을 위한 기본 URL입니다 (예: https://petstore3.swagger.io/api/v3).
  • BasePath: 도메인에 추가되어 API 엔드포인트의 전체 기본 URL을 생성하는 경로 세그먼트입니다. 값이 /인 경우 엔드포인트가 도메인 루트에서 직접 접근됨을 나타냅니다.

인증 정보​

이 섹션은 API에 접근하기 위한 보안 요구 사항을 명시합니다.

  • Authentication Type: API를 보호하는 데 사용되는 방법을 정의합니다. 예를 들어, 값이 None인 경우 API는 공개적이며 접근을 위해 자격 증명이나 토큰이 필요하지 않음을 의미합니다.

메타 정보​

이 섹션은 시스템 내에서 API의 생애 주기에 대한 감사 및 추적 정보를 제공합니다.

  • Date of Creation: API가 시스템에 처음 등록된 정확한 날짜와 시간입니다.
  • Constructor: API를 생성한 개인 또는 프로세스의 사용자 이름 또는 ID입니다.
  • Date of Modification: API의 구성이 마지막으로 업데이트된 시간을 나타내는 타임스탬프입니다.
  • Modifier: 가장 최근 변경을 수행한 개인 또는 프로세스의 사용자 이름 또는 ID입니다.

API 미리보기​

API 미리보기 탭은 Swagger UI와 같은 도구로 구동되는 대화형 사용자 인터페이스를 제공하여 브라우저에서 직접 API의 엔드포인트를 탐색하고 테스트할 수 있게 합니다.

API 사양​

이 섹션에서는 API 사양의 주요 식별 세부 정보를 찾을 수 있습니다.

  • API Title: API의 공식 이름입니다.
  • Version Badges: API의 버전 번호를 나타내는 작은 태그(예: 1.0.27)와 준수하는 사양(예: OpenAPI Specification 3.0의 경우 OAS 3.1)입니다.
  • Description: API에 대한 사람이 읽을 수 있는 요약입니다.

API 인증​

이 섹션에서는 테스트 요청을 구성하고 인증하는 데 필요한 요소를 찾을 수 있습니다.

  • Servers: API 호출을 위한 대상 서버 환경을 선택하는 드롭다운 메뉴입니다. 이를 통해 개발, 스테이징 또는 프로덕션 환경과 같은 다양한 기본 URL 간에 전환할 수 있습니다.
  • Authorize: 인증 자격 증명(예: API 키 또는 OAuth2 토큰)을 입력할 수 있는 대화 상자를 여는 버튼입니다. 설정이 완료되면 이러한 자격 증명은 이 페이지에서 수행하는 모든 테스트 요청에 자동으로 포함됩니다.

API 엔드포인트​

이곳은 API 미리보기의 핵심으로, 사용 가능한 모든 작업이 나열됩니다.

  • Endpoint Groups: 엔드포인트는 일반적으로 특정 리소스에 해당하는 "태그"를 기반으로 논리적 그룹으로 구성됩니다. 이 예에서는 모든 엔드포인트가 pet 태그 아래에 그룹화되어 있습니다.
  • Endpoint Details: 각 줄은 수행할 수 있는 단일 작업을 나타내며 다음을 포함합니다:
    • HTTP Method: PUT(업데이트), POST(생성) 또는 GET(읽기)와 같은 작업 유형입니다.
    • Path: 엔드포인트의 특정 URL 경로(예: /pet, /pet/findByStatus)입니다.
  • Description: 엔드포인트가 수행하는 작업에 대한 간략한 요약입니다.
    • Authentication Indicator: 잠금 아이콘은 엔드포인트가 인증을 요구하는지 여부를 나타냅니다. 잠금 해제된 아이콘은 열려 있음을 의미하고, 잠금된 아이콘은 인증 버튼을 사용하여 자격 증명을 제공해야 함을 의미합니다.

모든 엔드포인트 행을 클릭하면 필요한 매개변수, 요청 본문 구조, 가능한 응답을 포함한 자세한 정보를 볼 수 있으며, 실시간 API 호출을 실행할 수도 있습니다:

Schemas​

미리보기 페이지 하단에 위치한 Schemas 섹션은 API의 요청 및 응답에 사용되는 모든 데이터 모델의 구조를 정의합니다.

  • Schema List: 이 영역은 Pet, Order, User와 같은 정의된 모든 데이터 객체를 나열합니다.
  • View Details: 원하는 스키마 이름을 클릭하면 확장됩니다. 이로 인해 객체의 속성에 대한 자세한 보기가 표시되며, 필드 이름(예: id, name), 데이터 유형(예: integer, string) 및 예제가 포함됩니다.