Change API Settings

기존 API의 구성을 수정하여 API의 핵심 세부정보, 사양 출처, 레이블 및 보안 설정을 업데이트할 수 있습니다.

그리드 보기(Grid View)를 사용하는 경우, 세 점 메뉴를 클릭하여 작업 항목을 열고, 편집 버튼(연필 아이콘)을 클릭하여 API 세부정보 양식을 엽니다.

리스트 보기(List View)를 사용하는 경우, Action 열로 이동하여 편집 버튼(연필 아이콘)을 클릭하여 API 세부정보 양식을 엽니다.

편집 버튼을 클릭하면 API 세부정보 편집 양식이 열립니다. 필요한 변경 사항을 입력합니다.

• Backend Name: (필수 필드) API에 대한 사용자 친화적인 표시 이름 (예: PetstoreV3).

• Backend System Name: (자동 채워지는 필드) API에 대한 고유한 내부 식별자 (예: petstorev3). 이 이름은 일반적으로 시스템 참조에서 사용되며 문자 제한이 있을 수 있습니다.

• Version: (필수 필드) API의 버전 번호 (예: v1.0.0). 의미론적 버전 관리 관행을 따르는 것이 좋습니다.

• Domain: (필수 필드) API가 호스팅되는 기본 도메인 (예: https://petstore3.swagger.io/api/v3).

• BasePath: (필수 필드) 모든 엔드포인트의 전체 기본 URL을 형성하기 위해 도메인에 추가되는 하위 경로 (예: /).

• Open API Specification: (필수 필드) 모든 엔드포인트와 작업을 설명하는 API의 정의 문서를 제공합니다. 이 정의의 출처를 세 가지 방법 중 하나로 지정해야 합니다.

  • From URL: OpenAPI 정의 파일에 대한 직접 웹 링크를 제공합니다 (예: .json 또는 .yaml 파일).

• Paste JSON: OpenAPI JSON 정의의 원시 내용을 텍스트 필드에 직접 붙여넣습니다.

• Upload File: 로컬 컴퓨터에서 OpenAPI 정의 파일을 업로드합니다.

• Description: (필수 필드) API의 목적과 기능에 대한 자세하고 사람이 읽을 수 있는 설명을 제공하는 텍스트 필드입니다. 이 정보는 API 개요 화면에 표시되며 다른 사용자가 API를 사용하는 방법을 이해하는 데 도움이 됩니다.

• Authentication Type: (필수 필드) 클라이언트가 API에 접근하기 위해 필요한 보안 방법을 선택합니다.

  • Basic: 인증을 위해 사용자 이름과 비밀번호가 필요합니다.
  • Bearer: Authorization 헤더에 베어러 토큰(예: JWT)이 필요합니다.
  • API Key: 요청 헤더 또는 쿼리 매개변수에 전송될 특정 API 키가 필요합니다.
  • None: API는 공개적이며 접근을 위한 인증 자격 증명이 필요하지 않습니다.

• Label: 이 섹션에서는 API에 대한 조직, 필터링 또는 사용자 정의 메타데이터 추가에 사용되는 키-값 쌍인 태그를 관리할 수 있습니다.

  • 레이블 추가: 플러스(+) 아이콘을 클릭하여 레이블을 위한 새 행을 추가합니다.
  • 키 / 값: 각 레이블은 키(식별자, 예: environment)와 값(데이터, 예: demo) 모두를 필요로 합니다. 오류 메시지에서 알 수 있듯이 레이블 행이 추가되면 두 필드가 모두 필요합니다.
  • 레이블 삭제: 휴지통 아이콘을 클릭하여 해당 레이블 행을 제거합니다. 입력한 정보를 검증한 후, Save 버튼을 클릭하여 API에 새 구성을 적용합니다. 이 화면에서 변경한 모든 내용을 취소하려면 Cancel 버튼을 클릭하여 양식을 닫으면 됩니다.