본 문서에서는 BizUnit의 구조와 NBlock을 활용한 블록 코딩 방법에 대해 설명합니다.
Index
Plan Control
•
NBlock의 일부 기능은 구독하신 Plan에 의해 제어합니다.
BizUnit 구조
•
BizUnit을 생성하면, API 통신에 필요한 기본적인 템플릿이 제공됩니다.
•
BizUnit의 구조는 크게 4개로 구분됩니다.
구분 | 기능 |
Request | API 호출을 요청하는 request data를 정의하는 영역입니다. |
Statement | API가 작동하는 비즈니스 로직을 작성하는 영역입니다. |
Response | 호출한 API를 실행한 후 되돌려 줄 응답을 정의하는 영역입니다. |
Exceptions | API 동작 시 발생하는 예외 상황을 정의하고 처리하는 영역입니다. |
NBlock 작성 화면
•
NBlock 작성 페이지는 다음과 같은 정보를 가지고 있습니다.
No. | 기능 |
1 | 현재 BizUnit의 정보와 경로를 확인할 수 있습니다.
App : [BizUnit이 속한 Apps 이름] > BizUnit : [BizUnit 이름_버전] > Revision : [BizUnti revision [revision name]] |
2 | 현재 작업 중인 BizUnit의 다른 Revision을 선택하는 드롭다운 목록입니다.
다른 Revision이 없을 경우 버튼을 선택해도 목록이 나타나지 않습니다. |
3 | Revision 상태 변경 버튼입니다. (Active ⇆ Standby) |
4 | 해당 Revision을 공유한 계정의 개수입니다. |
5 | NBlock의 Category입니다.
Category 선택 시 각 Category에 속한 NBlock이 나타나며 NBlcok을 선택해 사용할 수 있습니다. |
6 | NBlock Save 버튼으로 작업한 Block을 저장할 수 있으며, Ctrl+S 로도 작동이 가능하다. |
7 | Revision Build 버튼입니다.
Build를 진행하기 위해서는 Save가 먼저 선행돼야 합니다. |
8 | Revision Push 버튼입니다. (Revision List의 Push와 동일한 기능)
Revision의 상태가 Active상태일 때 나타나며, 버튼 선택 시 Push 안내 Popup이 노출됩니다. |
NBlock 부가 기능
•
NBlock 작성 페이지에서 제공하는 다양한 부가 기능입니다.
1) API Document 제공
•
Save, Build까지 마친 NBlock은 우측 상단의 Document 버튼을 통해 별도의 API Document 페이지를 확인할 수 있습니다.
•
이 정보를 활용해 외부 테스트 툴을 활용해서 API를 테스트할 수 있습니다.
2) API Tester 사용하기
•
Save, Build까지 마친 NBlock은 Test버튼이 활성화되며, 별도의 외부 테스트 툴을 사용하지 않고 직접 빠르게 API 테스트할 수 있습니다.
•
NBlock의 request 영역을 통해 정의한 request data가 Header 영역에 표시되며, + 버튼으로 추가 data를 입력할 수 있습니다.
•
request body는 JSON, Text, Form(Key / Value) 타입으로 입력할 수 있습니다.
•
하단의 Run을 누르면 API가 작동하며 Response와 Console Log를 확인할 수 있습니다.
3) Exception Block Shortcut
•
Test 진행 중 Exception이 발생한 경우 Console 탭에 [!] 아이콘이 표시됩니다.
•
오류가 발생한 블록의 링크가 생성되며 클릭하여 해당 블록으로 바로 이동이 가능합니다.
4) JSON 데이터를 Block으로 만들기
•
직접 JSON 형식으로 구성한 데이터를 Block으로 만들 수 있습니다.
•
5) Comment 블록과 Zoom, 휴지통 활용
•
Helper의 Comment, Comment Statement 블록을 사용하면 우측 상단에 깃발 아이콘이 나타납니다. 깃발 클릭 시, Comment List 를 볼 수 있어 메모를 남길 수 있습니다.
•
또한 Comment를 클릭하면 해당 Block이 있는 위치로 바로 이동하여 Check point 처럼 사용 가능합니다.
•
Comment Statement 블록의 ignore-code 안에 넣은 블록은 주석 처리됩니다.
•
Zoom-in/out 버튼으로 NBlock 화면 크기를 조정할 수 있습니다.
•
블록을 드래그하여 휴지통에 넣을 수 있고, 휴지통에 담긴 블록은 일정 시간 동안 남아있어 다시 블록을 꺼낼 수도 있습니다.
6) BizUnit Connect
•
Extension을 통해 내 블록 혹은 다른 사람이 공유한 블록들을 볼 수 있습니다.
◦
My : 내 Revision중 Active중인 Revision이 호출됩니다.
◦
Other : 공유 받은 Revision이 호출됩니다.
7) Code Split
•
Code Split은 대량으로 블록을 등록한 경우, 일정한 기준에 따라 블록 화면을 자동으로 분할하여 볼 수 있는 기능입니다.
•
Code Split 설정
◦
NBlock 화면에서 toggle button을 통해 Code Split 적용 여부를 선택할 수 있습니다.
◦
NBlock을 Save해야 버튼이 활성화됩니다.
◦
‘?’ icon에서 Code Split에 대한 설명을 확인할 수 있습니다.
Moves to a page where you can check the flow in Code Section units.
At least one block must exist in the statement. After saving, the button becomes active. If there are any changes, please save them and use the function.
* If there is no block in the statement, the button will not be active after saving.
* Blocks that are not grouped as Code Sections are grouped by 500 units.
=====================================================
Code Section 단위로 흐름을 확인할 수 있는 페이지로 이동합니다.
Statement 안에 한 개 이상의 블록이 존재해야 합니다. 저장 후에 버튼이 활성화 됩니다. 변경 사항이 있다면 저장 후에 기능을 이용해주세요.
* Statement 안에 블록이 한 개도 없는 상태라면 저장 후에도 버튼이 활성화되지 않습니다.
* Code Section으로 묶여있지 않은 block들은 500개씩 묶이게 됩니다.
•
Flow : Code Split으로 나누어진 화면을 지칭합니다.
No. | 기능 |
1 | Code Split으로 나누어진 BizUnit의 전체 Flow를 확인할 수 있습니다. |
2 | 선택한 Code Section Flow는 배경색이 다르게 표시됩니다. |
3 | Code Section name은 ‘Code Section {n}’이 기본값이며, Comment Block으로 이름을 변경할 수 있습니다.
Request / Response / Exception {n}의 이름은 바꿀 수 없습니다. |
4 | Exception 블록이 여러 개 있을 경우 Split시 ‘Exception {n}’으로 생성됩니다. |
5 | Flow 화면에 접근한 이후 Save를 해야 Flow가 다시 활성화됩니다. |
6 | Flow 화면에서는 debug 기능이 제한(disabled) 됩니다. |
7 | 블록 검색은 해당 Code Section Flow 안에서만 활성화 됩니다. |
•
Code Split 기준은 다음과 같습니다.
◦
◦
하나의 블록이 500개가 넘는 블록을 포함하는 경우
◦
500개 기준으로 블록을 자르고 남는 블록이 있는 경우
◦
n+1개의 블록을 더하면 500개가 초과되는 경우
Code Split 기능은 솔루션 공급 방식에 따라 제한적으로 제공됩니다.
8) Debugger (Beta)
•
Debug 기능을 통해 오류가 발생하는 블록의 위치를 쉽고 확실하게 찾을 수 있습니다.
•
Debug 버튼은 BizUnit의 Save와 Build 이후 활성화 됩니다.
•
Debug Button 설명
◦
Start Debug 버튼 : 전체 블록을 한 단계 씩 차례로 실행합니다.
◦
Next Step 버튼 : 다음 단계 블록의 실행을 진행합니다. 오류가 있는 블록에 도달하면 그 블록을 강조하고 오류 상세 정보를 표시합니다.
Debug 오류 상세 정보 표시 화면
◦
Stop Debug 버튼 : 클릭 시 실행 중인 Debug를 종료합니다.
•
‘?’ icon에서 Debug에 대한 설명을 확인할 수 있습니다.
We release the debug feature as a beta version. You can easily and reliably find the location of the error in the block coding where the error occurs.
•
When the Start Debug button is clicked, it starts executing the entire block step by step.
•
Continue to the next step by clicking the Next Step button! When a block with an error is reached, it will be highlight and the error details will be shown.
•
Request and Response are included in the basic inspection, and if a 'Log/Debug message' block is included in the Statement, the inspection starts from that block.
* The debug function is currently in beta, and you can debug block coding consisting of up to 2,000 blocks.
* If you use the split function, the debug function is deiabled.
* Debug function is diasbled if the proxy path contains a dynamic url.
=====================================================
Debug 기능을 베타 버전으로 출시합니다. 오류가 발생한 블록의 위치를 쉽고 안정적으로 찾을 수 있습니다.
•
Debug 시작 버튼을 클릭하면 전체 블록을 단계별로 실행하기 시작합니다.
•
다음 단계 버튼을 클릭하면 다음 단계로 넘어갑니다! 오류가 있는 블록에 도달하면 해당 블록이 강조 표시되고 오류 세부 정보가 표시됩니다.
•
Request와 Response 영역은 기본 검사에 포함되며, Statements에 'Log/Debug' 블록이 포함된 경우 해당 블록부터 검사가 시작됩니다.
•
Debug 기능은 현재 베타 버전이며, 최대 2,000개의 블록을 검사할 수 있습니다.
* Proxy가 동적 URL인 경우 Debug 기능이 비활성화됩니다.
Debug 기능은 솔루션 공급 방식에 따라 제한적으로 제공됩니다.