Apidog의 게시된 API 문서는 API에 대한 대화형의 포괄적인 보기를 제공합니다. 사용자가 문서 URL에 접근하면, 쉽게 이해하고 테스트할 수 있도록 설계된 여러 섹션과 함께 각 엔드포인트가 잘 구조화되어 표시됩니다.문서 구조#
각 엔드포인트 페이지에는 다음 섹션이 포함됩니다.메타데이터#
이 섹션에는 URL, HTTP 메서드, 수정 시간, 설명과 같은 필수 엔드포인트 정보가 표시됩니다. 문서를 생성할 때 표시할 필드를 선택할 수 있습니다.엔드포인트 상태#
"Released" 상태인 엔드포인트에는 상태 태그가 표시되지 않습니다. 다른 상태(예: "Developing")인 엔드포인트에는 엔드포인트 이름 뒤에 상태 태그가 표시됩니다. "Deprecated" 상태인 엔드포인트는 왼쪽 디렉터리 트리에서 "엔드포인트 이름"으로 표시됩니다.엔드포인트 설명#
엔드포인트 설명의 Markdown 콘텐츠는 렌더링되어 메타데이터 섹션 끝에 표시됩니다.사용해 보기#
"Try it out"을 클릭하면 요청을 전송하고, 매개변수를 수정하며, 환경을 전환할 수 있는 대화형 테스트 레이어가 확장됩니다. 사용 가능한 환경은 문서를 생성할 때 선택한 환경입니다.문서를 생성할 때 Cloud mock 환경을 선택하면, 독자에게 API 테스트를 위한 간단한 샌드박스 환경을 제공하게 됩니다. 변수 사용#
요청 예시에서 {{variables}}가 사용된 경우, 독자는 요청을 전송하기 전에 변수 값을 설정해야 합니다.자격 증명 사용#
프로젝트의 Auth 설정 내에서 API 또는 폴더 수준으로 인증을 구성할 수 있습니다. security schemes를 사용하거나 설정을 수동으로 정의하십시오.예를 들어 Bearer Token 인증을 사용하도록 인증 설정을 구성한 후에는 "Publish Documentation" 패널 상단에 "Credentials" 섹션이 표시되며, 여기에서 토큰 값을 직접 입력할 수 있 습니다.이 구성 방식의 주요 이점은 인증 정보를 여러 API 간에 공유할 수 있다는 점입니다. 여러 API가 동일한 security scheme 또는 인증 유형을 참조하는 경우, 인증 정보를 한 번만 입력하면 다른 API에서 이를 자동으로 재사용할 수 있습니다.이러한 자격 증명은 암호화되어 브라우저의 LocalStorage에 저장되며, 브라우저 세션을 기준으로 관리됩니다. 동일한 세션 내에서는 여러 창과 탭에서 공유할 수 있습니다. 브라우저가 닫히고 세션이 종료되면 이러한 자격 증명은 자동으로 유효하지 않게 됩니다.보다 구체적으로 설명하면, LocalStorage에 저장된 자격 증명은 암호화되어 있으며, 복호화 키는 세션 쿠키에 저장됩니다. LocalStorage의 데이터는 장기적으로 유지되지만, 세션 쿠키의 복호화 키는 브라우저가 닫히는 즉시 만료됩니다. 따라서 암호화된 데이터는 더 이상 복호화하거나 접근할 수 없으며, 다음에 방문할 때 자격 증명을 다시 입력해야 합니다.이 섹션에는 매개변수와 본문 사양이 표시됩니다. Apidog는 두 가지 매개변수 표시 스타일인 Modern 또는 Classic을 지원하며, Settings → Feature Settings → Endpoint Feature Settings에서 선택할 수 있습니다.요청 샘플#
다양한 프로그래밍 언어의 요청 코드 샘플입니다. 공유를 생성할 때 이 모듈을 표시할지 여부를 선택할 수 있습니다.응답 사양과 예시가 Apidog 클라이언트에서와 동일하게 표시됩니다.내보내기#
문서를 생성할 때 "Allow exporting data"를 선택한 경우, 독자는 오른쪽 아래 모서리와 문서의 맨 아래에서 Export 옵션을 볼 수 있습니다.독자는 "Clone" 또는 "Export" 중에서 선택할 수 있습니다. "Export"는 OAS, HTML, Markdown, Apidog 형식으로 내보내기를 지원합니다. Modified at 2026-06-09 08:53:32
