온보딩 가이드

조직 내에서 Apidog 사용을 시작하려면, 다음 작업을 따라 Apidog 팀이 성공적으로 시작할 수 있도록 설정하실 수 있습니다. 먼저 팀 관리자 및 조직의 IT 팀과 협력하여 조직 내 Apidog을 설정, 보안 구성 및 관리하시는 것을 권장합니다. 그런 다음 관련 설정을 구성하고, 팀에 사람들을 초대하여 역할을 할당하며, 프로젝트와 관련된 리소스를 생성하여 Apidog 팀을 설정하실 수 있습니다.

Windows, Mac, Linux용 Apidog 데스크톱 앱을 download and install하실 수 있습니다. 또한 Apidog Agent를 사용하여 웹에서 Apidog에 접근하실 수도 있습니다.

IT 팀과 협업하기

새 소프트웨어를 추가하는 절차는 조직마다 다르므로, 해당 절차를 수립하기 위해 IT 팀에 문의하십시오. 일반적으로 다음과 같은 항목을 다룹니다.

IT 팀은 직원 워크스테이션에 Apidog을 설치할 수 있도록 기기 정책에 예외를 추가해야 할 수 있습니다. 이 예외를 설정하는 데 도움이 되도록 IT 팀에 Apidog download link를 제공하십시오.

조직의 네트워크 연결이 프록시 뒤에 있는 경우, Apidog을 적절하게 구성해야 할 수 있습니다. IT 팀으로부터 프록시 연결 세부 정보를 받아 Apidog 내에서 설정하십시오.

INFO

이미 Apidog에 로그인하신 경우, Apidog 인터페이스의 오른쪽 상단에 있는 ⚙Settings → Proxy 옵션으로 이동하여 프록시를 설정하실 수 있습니다. 또는 아직 Apidog에 로그인하지 않으신 경우, Apidog 클라이언트 애플리케이션의 로그인 화면 왼쪽 하단에서 프록시 설정을 구성하실 수 있습니다.

조직이 방화벽 뒤에서 운영되는 경우, IT 팀은 Apidog 도메인에 대한 허용 목록을 구성해야 할 수 있습니다. 이를 통해 Apidog 데이터가 클라우드와 동기화되고 모든 기능이 예상대로 작동하도록 보장할 수 있습니다.

INFO

Apidog의 도메인은 다음과 같습니다.

*.apidog.com

*.apidog.io

Apidog 팀 설정하기

먼저 조직 내에서 어떤 구성원이 팀 관리자가 될지 결정해야 합니다. 팀 관리자는 Apidog 계정을 등록하고, 새 팀을 생성할 수 있으며, 자동으로 이 새 팀의 팀 소유자가 됩니다.

팀 소유자는 다음 권한을 가집니다.

팀 정보 수정

새 프로젝트 생성

구성원 초대 및 제거

다른 구성원에 대한 팀 권한 및 프로젝트 권한 설정

구독 및 결제 관리

팀 이전 및 해산

팀은 여러 구성원으로 구성될 수 있으며 다양한 프로젝트를 관리할 수 있습니다. 관리자는 특정 프로젝트 내에서 어떤 구성원이 어떤 권한을 갖는지 결정할 권한을 가집니다.

Apidog 무료 버전에서는 팀이 최대 4명의 구성원을 가질 수 있습니다. 팀이 4명을 초과하는 경우 Apidog의 유료 플랜으로 업그레이드해야 합니다.

팀 구성원 관리하기

팀 소유자는 몇몇 다른 구성원을 팀 관리자로 초대할 수 있으며, 해당 팀 관리자들은 이후 팀 내 추가 협업 구성원을 초대하고 관리하는 책임을 맡게 됩니다.

팀 관리자는 이메일 또는 초대 링크를 통해 다른 구성원을 초대하여 팀에 참여시킬 수 있습니다. 구성원을 초대할 때, 팀 내 프로젝트에 대한 구성원의 기본 권한을 설정할 수 있습니다. 이러한 권한에는 일반적으로 Admin, Editor, Read-only, Forbidden이 포함됩니다.

Apidog에서는 팀 권한과 프로젝트 권한이 서로 다른 승인 수준이라는 점에 유의하는 것이 중요합니다. 팀 권한은 팀 설정, 구성원 관리 및 전반적인 팀 거버넌스를 포함하여 팀 전체를 관리하는 데 사용됩니다. 팀 권한에는 Team owner, Team Admin, Team member, Guest와 같은 역할이 포함됩니다.

반면, 프로젝트 권한은 팀 내 개별 프로젝트를 관리하도록 특별히 설계되어 있습니다. 이러한 권한은 프로젝트 설정, 접근 제어 및 프로젝트 범위 내 협업과 관련된 요소를 제어합니다. 프로젝트 권한은 Admin, Editor, Read-only 또는 Forbidden과 같은 역할로 구성되며, 이는 특정 프로젝트 내에서 팀 구성원이 갖는 제어 및 접근 수준을 결정합니다.

프로젝트 생성하기

팀 소유자와 팀 관리자는 팀 내에서 새 프로젝트를 생성할 수 있습니다. 프로젝트를 생성할 때 프로젝트 이름과 설명을 지정하고, 필요에 따라 적절한 프로젝트 템플릿을 선택하실 수 있습니다.

프로젝트를 생성한 후에는 팀 구성원을 프로젝트에 초대하고 적절한 프로젝트 권한을 할당하실 수 있습니다. 이를 통해 팀 구성원은 프로젝트에서 협업하고, 할당된 권한에 따라 프로젝트 리소스에 접근할 수 있습니다.

데이터 마이그레이션하기

다른 API 관리 도구에서 Apidog으로 마이그레이션하는 경우, 기존 API 데이터를 Apidog으로 가져올 수 있습니다. Apidog은 OpenAPI/Swagger, Postman 등 다양한 형식의 데이터 가져오기를 지원합니다.

데이터를 가져오려면 프로젝트 설정으로 이동하여 Import Data 옵션을 선택하십시오. 적절한 가져오기 형식을 선택하고 화면의 지침에 따라 가져오기 프로세스를 완료하십시오.

초기 설정 구성하기

팀을 설정하고 프로젝트를 생성한 후에는 조직의 요구 사항에 맞게 Apidog을 사용자 지정하기 위한 초기 설정을 구성하실 수 있습니다. 여기에는 다음이 포함됩니다.

팀 설정: 팀 이름, 설명, 아바타와 같은 팀 수준 설정을 구성합니다.

프로젝트 설정: 프로젝트 이름, 설명, 기본 환경과 같은 프로젝트 수준 설정을 구성합니다.

환경 변수: 다양한 환경(예: 개발, 스테이징, 프로덕션)을 관리하기 위해 환경 변수를 설정합니다.

알림 설정: 중요한 이벤트에 대한 알림을 수신하도록 알림 설정을 구성합니다.

이 단계를 따르면 조직 내에서 Apidog을 설정하고 팀과 함께 API 설계, 개발 및 문서화 작업을 시작하실 수 있습니다.

IT 팀과 협업하기#

Apidog 팀 설정하기#

팀 구성원 관리하기#

프로젝트 생성하기#

데이터 마이그레이션하기#

초기 설정 구성하기#

IT 팀과 협업하기

Apidog 팀 설정하기

팀 구성원 관리하기

프로젝트 생성하기

데이터 마이그레이션하기

초기 설정 구성하기