새 API 프로젝트 생성

Apidog에서 각 프로젝트는 API Specification 또는 OpenAPI Specification(OAS) 파일에 해당합니다. Apidog 앱의 Home > My Teams > Projects 섹션에서 새 API 프로젝트를 생성하거나 기존 프로젝트를 가져올 수 있습니다.

프로젝트 생성

main window에서 오른쪽 상단의 + New Project 버튼을 클릭하십시오.

상단에서 프로젝트 카테고리인 General 또는 gRPC를 선택하십시오.

General: 대부분의 API에 대해 이 옵션을 선택하십시오. HTTP(s), WebSocket, Socket.IO, Webhook, Markdown 등을 지원합니다.

gRPC: gRPC 프로토콜을 사용하는 API에 대해 이 옵션을 선택하십시오. gRPC projects에 대해 자세히 알아보십시오.

(General을 선택한 경우) 선호하는 프로젝트 모드를 선택하십시오. Apidog는 General Mode와 Spec-first Mode라는 두 가지 고유한 워크플로를 제공합니다. 선택하신 항목에 따라 아래 지침을 따르십시오.

General Mode

GUI 기반 워크플로에 가장 적합합니다. API 설계, 디버깅, 테스트 및 자동 생성 문서를 위한 Visual API Editor가 포함되어 있습니다. 또한 자동 생성된 OpenAPI Specs를 Git 저장소에 백업할 수 있습니다.

General Mode를 선택하십시오.

프로젝트 이름을 입력하십시오.

(선택 사항) PetStore 예제의 샘플 데이터로 프로젝트를 생성하려면 Including Examples 옵션을 선택하십시오.

(여러 사용자가 있는 팀의 경우) 프로젝트 생성 중 다른 팀 구성원에 대한 권한을 설정하십시오. 자세한 내용은 Member permissions settings를 참조하십시오.

(선택 사항) Project language를 설정하십시오. 자세한 내용은 Language settings를 참조하십시오.

Spec-first Mode (Beta)

네이티브 Git 워크플로에 이상적입니다. OpenAPI Spec Editor(YAML/JSON 파일)를 사용하여 API 사양을 설계하고 Git 저장소와 원활한 양방향 동기화를 유지하십시오.

Spec-first Mode를 선택하십시오.

Connect with Git Repository 섹션까지 아래로 스크롤하십시오.

Connect to GitHub 또는 Connect to GitLab SaaS를 클릭하여 저장소를 연결하고 동기화 설정을 구성하십시오.

(여러 사용자가 있는 팀의 경우) 다른 팀 구성원에 대한 권한을 설정하십시오. 자세한 내용은 Member permissions settings를 참조하십시오.

자세히 알아보기

코드 기반 Specs 작업 공간, 실시간 디렉터리 파싱 및 Git 커밋 워크플로에 대해 자세히 알아보려면 Spec-first Mode에 대한 상세 가이드를 확인하십시오.

기존 API 가져오기

이미 API Specification이 있는 경우, Team > Projects 섹션에서 Import Project를 선택하거나 기존 프로젝트 내에서 큰 ➕ 기호를 클릭하고 Import를 선택하여 가져오기 프로세스를 시작할 수 있습니다. 이는 기존 API 데이터를 Apidog로 마이그레이션하는 데 적합합니다.

**"Import Project"**를 클릭하십시오.

가져오려는 데이터 유형을 선택하십시오.

파일을 업로드하거나 데이터 URL을 붙여넣으십시오(OpenAPI/Swagger 형식만 해당).

Apidog가 선택한 형식에 따라 콘텐츠를 자동으로 인식하고 파싱합니다. 가져오기 전에 데이터를 미리 볼 수 있습니다. 가져오려는 항목을 선택하고 가져오기 로직을 구성하십시오. 그런 다음 확인하여 프로젝트를 생성하고 가져오십시오.

가져오기가 완료되면 새 프로젝트를 사용할 준비가 됩니다.

자세히 알아보기

가져오기 프로세스에 대한 자세한 내용은 Import Guidelines를 참조하십시오.

새 API 프로젝트 생성

프로젝트 생성#

General Mode#

Spec-first Mode (Beta)#

기존 API 가져오기#

프로젝트 생성

General Mode

Spec-first Mode (Beta)

기존 API 가져오기