사용자 지정 엔드포인트 필드

API에서 협업할 때 엔드포인트를 설명하기 위한 사용자 지정 추가 필드가 필요할 수 있습니다. 예를 들어 API를 사용하는 사용자에게 더 많은 맥락을 제공하기 위해 "Authorization Required", "Response Format" 또는 "Rate Limiting Policy"와 같은 필드를 추가할 수 있습니다.

Apidog에서는 Customized Fields를 활용하여 이러한 추가 필드를 원활하게 구현하실 수 있습니다.

사용자 지정 필드 구성

Apidog에서 Settings > General Settings > Feature Settings > Endpoint Feature Settings로 이동하여 엔드포인트 필드를 설정하실 수 있습니다. 여기에서 구성한 사용자 지정 필드는 Apidog에서 프로젝트 전체에 적용됩니다.

Apidog는 수동으로 활성화하거나 비활성화할 수 있는 기본 내장 필드 세 가지를 제공합니다. 활성화하면 해당 필드가 엔드포인트 메타데이터에 표시됩니다.

새 필드 추가

필요에 따라 사용자 지정 필드를 유연하게 추가하실 수도 있습니다.

지원되는 필드 유형:

텍스트

숫자

단일 선택

다중 선택

날짜

팀 멤버

링크

이메일

단일 레이블

다중 레이블

API 문서에 필드 표시

Quick Share에서는 이러한 사용자 지정 필드를 표시할지 여부를 선택할 수 있습니다.

Apidog에서 Quick Share를 생성할 때, 정의한 API 필드를 포함하려면 "Show API Fields" 옵션을 선택하실 수 있습니다.

표시할 필드를 선택합니다.

해당 필드는 문서에 표시됩니다.

Apidog에서 문서를 게시할 때도 표시할 필드를 선택할 수 있습니다. Publish Docs 섹션의 Publish Docs Sites > Customize > Appearance & Display Content에서 필드를 선택하는 옵션을 이용하실 수 있습니다.

사용자 지정 엔드포인트 필드

사용자 지정 필드 구성#

새 필드 추가#

API 문서에 필드 표시#

사용자 지정 필드 구성

새 필드 추가

API 문서에 필드 표시