API 문서 공유

API 개발 및 디버깅이 성공적으로 완료되면, Apidog를 사용하여 팀, 이해관계자 또는 외부 개발자와 공유할 수 있는 전문적인 문서를 쉽게 생성할 수 있습니다.

단계별 가이드

API 문서를 생성하고 공유하려면 다음 단계를 따르십시오.

1단계: Share Docs 모듈에 접근

1. Apidog 프로젝트를 여십시오.

2. 사이드바에서 Share Docs 모듈로 전환하십시오.

2단계: 새 공유 생성

1. New 버튼을 클릭하여 새 문서 공유를 시작하십시오.
2. 그러면 공유 구성 대화 상자가 열립니다.

3단계: 공유 설정 구성

공유 구성에서 다음 설정을 완료하십시오.

설정	설명	권장 작업
Name	공유에 설명적인 이름을 지정합니다.	프로젝트 이름 + 버전을 사용하십시오(예: "Pet Store API v1.2").
Environments	포함할 환경을 선택합니다.	포괄적인 문서를 위해 모든 환경을 선택하십시오.
Access	표시 권한을 설정합니다.	대상 사용자에게 적절한 접근 수준을 선택하십시오.


3. Save를 클릭하여 공유를 생성하십시오.

4단계: 문서에 접근

1. 새 공유가 공유 목록에 표시됩니다.
2. Open을 클릭하여 웹 브라우저에서 문서를 확인하십시오.
3. 문서는 공유 가능한 URL과 함께 새 탭에서 열립니다.

5단계: 문서 기능 살펴보기

문서에는 강력한 기능이 포함되어 있습니다.

• 대화형 API 탐색기: 왼쪽 디렉터리 트리에서 엔드포인트를 탐색합니다.

• Try It Out: 문서에서 직접 실시간 요청을 보냅니다.

• 코드 생성: 요청 코드 스니펫 및 데이터 모델 코드를 생성합니다.

• 환경 전환: 다양한 API 환경을 테스트합니다.

고급 사용자 지정 및 게시

Apidog는 문서에 대한 추가 사용자 지정 기능을 제공합니다.

기능	설명	사용 사례
Custom Layout	문서 구조와 모양을 수정합니다.	브랜드 일관성, 사용자 경험 최적화
Custom Domain	자체 도메인 이름을 사용합니다.	전문적인 프레젠테이션, 브랜드 인지도
Custom URLs	기억하기 쉽고 의미 있는 URL을 만듭니다.	마케팅, 쉬운 공유, SEO 이점
Access Control	세분화된 권한을 설정합니다.	내부 팀, 외부 파트너, 공개 접근

---

Apidog에서 API를 설계, 테스트, 목 처리 및 게시하는 방법에 대해 자세히 알아보십시오.