SyncTree는 블록 코딩 방식으로 BizUnit을 구성하여 API를 사용할 수 있습니다.
본 문서에서는 SyncTree로 BizUnit을 만들어 API를 생성하고 관리하는 방법을 설명합니다.
Index
BizUnit List
•
Bizunit List 페이지에서는 생성된 Bizunit의 정보 확인과 관리를 할 수 있습니다.
•
기본적인 구성은 App List 페이지와 동일합니다.
No. | 기능 |
1 | BizUnit의 API Method입니다. |
2 | 해당 BizUnit의 생성 시 입력한 Version으로 소수점 3자리 까지 입력 가능합니다. |
3 |
BizUnit 생성
•
우측 상단의 + Add BizUnit 버튼을 클릭한 후 BizUnit의 정보를 입력하여 BizUnit을 생성합니다.
•
BizUnit 정보 입력 필드에 관한 설명입니다.
기능 | 설명 |
Name | BizUnit의 이름을 작성합니다. |
Description | BizUnit의 설명을 작성합니다. |
Revision Name | BizUnit 내에 포함될 Revision 이름을 작성합니다. |
Version | BizUnit의 버전을 입력합니다.
숫자만 가능하며, 소수점 3자리 까지 입력 가능합니다.
버전 작성 예시)
0 / 1.0 / 1.01 / 1.12 / 1.123 (O)
0. / 0.1.1 / 0.1234 / a.0 (X) |
Proxy
1) Proxy 생성
•
기능 | 설명 |
Name | Proxy 의 이름을 작성합니다. |
Proxy Method | Proxy Method를 선택합니다. |
Base Path | Proxy의 경로를 입력합니다.
- 영어 소문자, 숫자, 슬래시(/), 대시(-), 언더스코어(_), 구두점(.), 중괄호({,}) 만 입력할 수 있습니다.
- Proxy Base Path가 같더라도 Method에 따라 별도 URI로 구분됩니다.
- segment(/로 나누어지는 depth)는 최대 12개 까지 가능합니다. |
Description | Proxy의 설명을 입력합니다. |
2) 동적 URL 생성
•
Base Path에 {} 를 통해 path parameter를 동적으로 적용할 수 있습니다.
규칙 | 비고 |
첫 번째 depth는 고정으로 설정합니다. | /api/{var1}/{var2} (O)
/{var1}/api/{var2} (X) |
Segment(/로 나뉘어지는 영역)는 최대 12개 까지 가능합니다. | - |
각 segment당 최대 60자 까지 입력 가능합니다. | - |
Base Path의 최대 길이는 720자 입니다. | - |
한 Proxy 안에 같은 변수를 두 번 이상 적용할 수 없습니다. | /api/{abc}/{abc} (X) |
다음과 같이 Path Variable의 양식에 맞지 않을 경우 등록이 되지 않습니다. | ① 중괄호를 썼지만 변수명을 입력하지 않았을 경우 (ex. {} )
② 중괄호를 입력하고 닫지 않았을 경우 (ex./{aaa)
③ 중괄호를 열지 않고 닫기만 했을 경우(ex./aaa} )
④ 양식에 맞지 않게 중괄호를 입력했을 경우(ex. /{aaa}} )
⑤ 슬래시 연속으로 두 번 이상 입력했을 경우(ex. //{a} |
•
동적 URL을 사용하게 되면?
◦
testbed에 path parameter를 입력할 수 있는 영역이 나옵니다.
•
Fetch 블록으로 path parameter의 값을 가져와 사용할 수 있습니다.
•
BizUnit 기능 버튼
•
BizUnit의 기능 버튼을 클릭하여 BizUnit의 정보 수정과 관리가 가능합니다.
1) BizUnit의 수정
•
Edit 버튼으로 Bizunit 및 Proxy의 정보를 수정할 수 있습니다.
2) BizUnit Push History 확인
•
기능 버튼의 Push History로 해당 BizUnit의 개발 환경 별 Push History를 확인할 수 있습니다.
SyncTree 개발 환경 구성
(→, ↑ : Push/ ↓ : Copy)
Dev(init) → Stage → Production
↑↓ ↑↓
Feature Hotfix (cf. Production과 Dev에 동시 push됨)
3) BizUnit 복제
•
Duplicate 기능 버튼을 통해 BizUnit 복제가 가능합니다.
•
Dev와 Production 단계에서 Active 상태인 BizUnit에 한해 복제가 가능합니다. (팝업 안내 문구)
•
BizUnit을 복제할 경우 아래와 같이 작업할 수 있습니다.
◦
Name은 수정할 수 없으며 Version으로 구분합니다.
◦
Version은 반드시 이전 Version보다 높은 숫자여야 합니다.
◦
Description, Proxy 내용은 자유롭게 수정 가능합니다.
