Quick Share

효과적인 API 협업을 위해서는 원활한 문서 공유가 필요합니다. Quick Share는 즉시 사용할 수 있는 온라인 문서 링크를 제공하여 Word 또는 PDF 파일을 주고받는 비효율을 제거합니다. 이 기능을 통해 팀 간 신속한 커뮤니케이션이 가능하며, 특정 API 엔드포인트를 협업자와 공유하는 동시에 접근 권한, 가시성 및 만료를 제어할 수 있습니다.

사전 요구 사항

Quick Share를 생성하기 전에 다음 사항을 확인하십시오.

프로젝트에 접근할 수 있는 Apidog 계정

공유할 API 엔드포인트 또는 문서

(선택 사항) 독자가 엔드포인트를 테스트하도록 하려는 경우 구성된 환경

왼쪽 사이드바에서 Publish Docs 모듈로 전환하십시오.

새 Quick Share를 생성하려면 +New를 클릭하십시오. 하나의 프로젝트는 여러 Quick Share를 지원하며, 이를 서로 다른 협업자에게 배포할 수 있습니다. 모든 팀 구성원은 팀 내 누구든 생성한 Quick Share를 볼 수 있습니다.

구성 옵션

New Share 대화 상자에서 다음 옵션을 사용자 지정할 수 있습니다.

Title: 이 공유의 이름입니다. Apidog 팀 내에서만 표시되며 내부 식별에 사용되고, 공유된 문서에는 표시되지 않습니다.

Environments: 온라인 문서에서 사용할 수 있는 환경을 선택합니다. 기본적으로 환경은 선택되어 있지 않습니다. 여러 환경을 선택할 수 있습니다. 선택한 환경은 문서에서 독자에게 표시되며, "Try it out"을 사용할 때 요청을 보내는 데 사용할 수 있습니다.

Cloud Mock Environment

문서를 생성할 때 Cloud 목 환경을 선택하면, 독자가 프로덕션 시스템에 영향을 주지 않고 API를 테스트할 수 있는 간단한 샌드박스 환경을 제공하게 됩니다.

Document content: 문서에는 Base URL과 Request samples라는 두 가지 선택적 구성 요소가 있습니다. 문서에 표시할지 여부를 선택할 수 있습니다.

Base URL: 환경에 설정된 기본 URL입니다. 선택하면 문서의 각 인터페이스에 전체 URL이 표시되며, 선택하지 않으면 문서의 URL은 "/"로 시작합니다.

Owners: 이 API 문서의 소유자를 표시합니다.

Request samples: 요청 호출을 위한 예제 코드를 표시할지 여부입니다. 자세한 내용은 request samples를 참조하십시오.

엔드포인트 설명 위에 'Last Modified' 시간을 표시합니다.

문서 끝에 'Last Modified' 시간을 표시합니다.

Allow 'Export', 'Clone' Data: 독자가 OAS/Markdown/HTML/Apidog 형식으로 데이터를 내보내고 복제할 수 있도록 허용할지 여부입니다.

Scope to share: 이 공유에 포함할 API 엔드포인트와 Markdown을 선택합니다. 디렉터리 또는 필터별로 선택하고 태그별로 제외할 수 있습니다. 또한 전체 폴더 공유를 선택할 수도 있습니다.

Security: 이 문서에 접근할 때 비밀번호가 필요한지 여부와 이 문서의 만료 시간을 설정할 수 있습니다. 만료 시간을 선택하지 않으면 만료되지 않습니다.

Show API Fields: 이러한 필드를 문서에 표시할지 여부를 설정할 수 있습니다. 포함 항목: Owners, Update time, OperationId, Original link, Authorization Required.

Language: 여기의 언어 설정은 문서 내 "Query Params", "Request samples" 등과 같은 기능성 고정 텍스트에 영향을 주지만, API 문서 콘텐츠에 작성된 텍스트에는 영향을 주지 않습니다.

CORS Proxy: API 문서에서 엔드포인트 요청을 처리하도록 CORS 프록시 서버를 배포하고 구성할 수 있습니다. Learn more.

Advanced Settings: Hide 'Try it out' Button 및 Hide 'Powered by Apidog'와 같은 옵션을 구성합니다.

Request Samples

공유를 생성할 때 요청 코드 샘플을 표시할지 여부를 선택할 수 있습니다.
요청 샘플을 사용자 지정하는 방법:

Settings → Feature settings → Endpoint feature settings → Endpoint fields에서 Request samples 필드를 활성화합니다.

Endpoint → Edit에서 끝부분에 Request samples 모듈이 표시됩니다.

선호하는 언어로 샘플을 추가하려면 Custom Request Code Samples를 클릭합니다.

전체 폴더 공유

Quick Share는 Share entire folder를 지원하며, 이는 공유 후에도 문서를 계속 추가하거나 제거하는 시나리오에 적합합니다. 활성화하면 협업자는 새 문서마다 공유 설정을 조정할 필요 없이 폴더 내 모든 문서에 자동으로 접근할 수 있습니다.

Scope to Share 섹션에서 Manual Selection을 선택하면 Share entire folder 옵션을 볼 수 있습니다. 활성화하면 협업자는 폴더 내 모든 문서에 자동으로 접근할 수 있습니다.

CORS Proxy 구성

외부 사용자와 API 문서를 공유할 때, 사용자가 브라우저에서 직접 엔드포인트를 테스트하면 Cross-Origin Resource Sharing (CORS) 문제가 발생할 수 있습니다. CORS 프록시는 지정된 프록시 에이전트를 통해 요청을 라우팅하여 브라우저의 CORS 제한을 우회하고 원활한 API 테스트를 가능하게 함으로써 이 문제를 해결합니다.

CORS 프록시를 구성하려면 새 공유 문서를 생성할 때 설정 옵션을 클릭하십시오. 기본적으로 Apidog는 모든 공유 문서에서 엔드포인트 요청을 관리하기 위해 Cloud Agent를 제공합니다.

CORS Proxy 옵션

요구 사항에 가장 적합한 CORS 프록시 옵션을 선택하십시오.

Cloud Proxy: Apidog의 Cloud Agent를 사용하여 엔드포인트 요청을 처리합니다. 참고: Cloud Agent는 내부 네트워크의 엔드포인트에 접근할 수 없습니다.

Browser Extensions: 사용자의 브라우저에 설치된 브라우저 확장 프로그램을 사용합니다. 확장 프로그램이 없는 사용자는 요청을 보내기 전에 설치하라는 안내를 받습니다.

No Proxy: 요청이 사용자의 브라우저에서 직접 전송됩니다. 엔드포인트 서버가 CORS를 올바르게 처리하도록 구성되어 있는지 확인하십시오.

Self-hosted Request Proxy Agent: 인프라 내에 배포된 Self-hosted Request Proxy Agent를 사용하여 엔드포인트 요청을 처리합니다.

사전 요구 사항#

Quick Share 생성하기#

구성 옵션#

Request Samples#

전체 폴더 공유#

CORS Proxy 구성#

CORS Proxy 옵션#

사전 요구 사항

Quick Share 생성하기

구성 옵션

Request Samples

전체 폴더 공유

CORS Proxy 구성

CORS Proxy 옵션