@fmsim/fmsim-restful 0.0.97 → 0.0.98

package/dist-app/helps/integration/task/pick-pending-scenario.md

@@ -1,13 +0,0 @@
-# Pickup Scenario
-
-[지연 큐](../concept/pending-queue.md)에 지연 만료된 시나리오를 꺼내서 실행(run)하는 태스크이다.
-
-## parameters
-
-- tag
-  - 시나리오에 붙여질 태그를 설정한다.
-- waitFor
-  - 지연 만료된 시나리오가 발생하는 것을 얼마의 시간동안 기다릴 것인지를 설정한다.
-  - 단위는 milli-seconds 이다.
-  - '-1'을 설정하면, 지연 만료된 시나리오를 무한시간동안 기다린다.
-  - 시나리오 선택을 기다리더라도, 해당 시나리오가 종료되면, 태스크도 종료된다.

package/dist-app/helps/integration/task/publish.md

@@ -1,16 +0,0 @@
-# publish
-
-subscription API를 통해서 요청된 모든 Subscriber에게 데이타를 브로드캐스트하는 태스크이다.
-
-클라이언트 어플리케이션에서 data subscription을 요청하는 방법은
-
-- Board UI에서 subscriber를 통해서 요청할 수 있다.
-- wss://[server host:port]/subscription API를 통해서 subscribe 요청할 수 있다.
-
-## parameters
-
-- [accessor](../concept/data-accessor.md)
-  - 시나리오 내의 하나의 스텝이름으로, 브로드캐스트하고자 하는 데이타를 지정한다.
-- tag
-  - 데이타를 브로드캐스트할 때 태그를 부여해서 보내야한다.
-  - subscriber들도 data를 subscribe할 때, 받고자 하는 테그를 설정하여, 해당 태그가 부여된 브로드캐스트만 받을 수 있다.

package/dist-app/helps/integration/task/random.md

@@ -1,13 +0,0 @@
-# Random Task
-
-무작위 데이터를 생성하는 태스크이다.
-지정된 형식(format)의 무작위 데이터를 지정된 갯수(count)만큼 배열로 생성한다.
-
-- 무작위데이터 생성방법은 [Chance Document](https://chancejs.com)를 따른다.
-
-## parameters
-
-- format
-  - 생성될 무작위 데이터의 형식을 지정한다.
-- count
-  - 생성될 무작위 데이터의 갯수를 지정한다.

package/dist-app/helps/integration/task/script.ja.md

@@ -1,37 +0,0 @@
-# スクリプト
-
-これは JavaScript 構文で書かれたスクリプトを実行し、その結果を返すタスクです。
-
-## パラメータ
-
-- script
-  - JavaScript 構文で記述します。
-  - グローバルオブジェクトは、対応する[シナリオコンテキスト](../concept/scenario-context.md)からのデータと変数を含むシンプルなオブジェクトです。つまり、スクリプト内では、シナリオの[スクリプト内蔵変数](../concept/script-internal-variables.md)から特別な修飾子なしで、または`this`アクセサを介してデータ、変数、ドメイン、ユーザー、lng 変数を使用できます。
-  - タスクの実行結果は`return`構文を介して返されます。
-  - スクリプト内のグ
-
-ローバルオブジェクトはデータと変数、および他の[スクリプト内蔵変数](../concept/script-internal-variables.md)に制限されているため、システム関連の機能のほとんどは使用できないサンドボックス環境として考えてください。単純な操作を実装することをお勧めします。 - [Node Sandbox](https://medium.com/@devnullnor/a-secure-node-sandbox-f23b9fc9f2b0) - [vm2](https://github.com/patriksimek/vm2/blob/master/README.md)
-
-## サンプルスクリプト
-
-```
-return data['step1'].map(record => {
-  return {
-    ...record,
-    id: 'PREFIX-' + record.id
-  }
-})
-```
-
-```
-return Math.floor(Number(this.data['step2']))
-```
-
-```
-return this.data['step3'].map(record => {
-  return {
-    ...record,
-    id: (this.variables.prefix || 'DEFAULT-') + record.id
-  }
-})
-```

package/dist-app/helps/integration/task/script.ko.md

@@ -1,37 +0,0 @@
-# Script
-
-Javascript Syntax로 작성된 script를 실행하여 그 결과를 리턴하는 태스크이다.
-
-## parameters
-
-- script
-  - javascript systax로 작성한다.
-  - global 오브젝트는 해당된 [Scenario Context](../concept/scenario-context.md)중 data 와 variables 를 가진 단순한 오브젝트이다. 즉, 스크립트 내에서 해당된 시나리오의 [스크립트 내장변수](../concept/script-internal-variables.md)인 data, variables, domain, user, lng 변수를 특별한 수식자없이 또는 this 접근자를 통해서 사용할 수 있다.
-  - 태스크의 수행 결과는 return 신택스를 통해서 반환된다.
-  - script 내에서는 global 오브젝트가 data와 variables 등 [스크립트 내장변수](../concept/script-internal-variables.md)로 한정되므로, 대부분의 시스템 관련된 기능은 사용할 수 없는 sandbox 환경이라고 이해하고, 단순한 연산정도의 기능을 구현하는 것을 권장한다.
-    - [Node Sandbox](https://medium.com/@devnullnor/a-secure-node-sandbox-f23b9fc9f2b0)
-    - [vm2](https://github.com/patriksimek/vm2/blob/master/README.md)
-
-## sample script
-
-```
-return data['step1'].map(record => {
-  return {
-    ...record,
-    id: 'PREFIX-' + record.id
-  }
-})
-```
-
-```
-return Math.floor(Number(this.data['step2']))
-```
-
-```
-return this.data['step3'].map(record => {
-  return {
-    ...record,
-    id: (this.variables.prefix || 'DEFAULT-') + record.id
-  }
-})
-```

package/dist-app/helps/integration/task/script.md

@@ -1,37 +0,0 @@
-# Script
-
-This is a task that executes a script written in JavaScript syntax and returns the result.
-
-## Parameters
-
-- script
-  - Write in JavaScript syntax.
-  - The global object is a simple object that contains data and variables from the corresponding [Scenario Context](../concept/scenario-context.md). In other words, within the script, you can use the data, variables, domain, user, and lng variables from the scenario's [Script Built-in Variables](../concept/script-internal-variables.md) without any special modifiers or through the `this` accessor.
-  - The task's execution result is returned through the `return` syntax.
-  - Since the global object within the script is limited to data and variables, as well as other [Script Built-in Variables](../concept/script-internal-variables.md), consider it a sandbox environment where most system-related functionalities are unavailable. It's recommended to implement simple operations.
-    - [Node Sandbox](https://medium.com/@devnullnor/a-secure-node-sandbox-f23b9fc9f2b0)
-    - [vm2](https://github.com/patriksimek/vm2/blob/master/README.md)
-
-## Sample Scripts
-
-```
-return data['step1'].map(record => {
-  return {
-    ...record,
-    id: 'PREFIX-' + record.id
-  }
-})
-```
-
-```
-return Math.floor(Number(this.data['step2']))
-```
-
-```
-return this.data['step3'].map(record => {
-  return {
-    ...record,
-    id: (this.variables.prefix || 'DEFAULT-') + record.id
-  }
-})
-```

package/dist-app/helps/integration/task/script.ms.md

@@ -1,37 +0,0 @@
-# Tugasan Skrip
-
-Ini adalah tugas yang menjalankan skrip yang ditulis dalam sintaks JavaScript dan mengembalikan hasil.
-
-## Parameter
-
-- skrip
-  - Ditulis dalam sintaks JavaScript.
-  - Objek global adalah objek sederhana yang mengandungi data dan pembolehubah dari [Konteks Senario](../concept/scenario-context.md) yang berkaitan. Dengan kata lain, dalam skrip ini, anda boleh menggunakan data, pembolehubah, domain, pengguna, dan pembolehubah lng dari [Pembolehubah Terbina Dalam Skrip](../concept/script-internal-variables.md) senario tanpa modifier khas atau melalui aksesori `this`.
-  - Hasil pelaksanaan tugas dikembalikan melalui sintaks `return`.
-  - Oleh kerana objek global dalam skrip terhad kepada data dan pembolehubah, serta Pembolehubah Terbina Dalam Skrip yang lain, pertimbangkan ia sebagai persekitaran sandbox di mana kebanyakan fungsi berkaitan sistem tidak tersedia. Disarankan untuk melaksanakan operasi yang ringkas.
-    - [Node Sandbox](https://medium.com/@devnullnor/a-secure-node-sandbox-f23b9fc9f2b0)
-    - [vm2](https://github.com/patriksimek/vm2/blob/master/README.md)
-
-## Skrip Contoh
-
-```
-return data['step1'].map(record => {
-  return {
-    ...record,
-    id: 'PREFIX-' + record.id
-  }
-})
-```
-
-```
-return Math.floor(Number(this.data['step2']))
-```
-
-```
-return this.data['step3'].map(record => {
-  return {
-    ...record,
-    id: (this.variables.prefix || 'DEFAULT-') + record.id
-  }
-})
-```

package/dist-app/helps/integration/task/script.zh.md

@@ -1,37 +0,0 @@
-# 脚本
-
-这是一个执行 JavaScript 语法脚本并返回结果的任务。
-
-## 参数
-
-- 脚本
-  - 以 JavaScript 语法编写。
-  - 全局对象是一个简单的对象，包含来自相应[场景上下文](../concept/scenario-context.md)的数据和变量。换句话说，在脚本内部，您可以使用来自场景的[脚本内置变量](../concept/script-internal-variables.md)（例如 data、variables、domain、user 和 lng 变量）而无需任何特殊修饰符，或者通过`this`访问器。
-  - 任务的执行结果通过`return`语法返回。
-  - 由于脚本内的全局对象仅限于数据和变量以及其他[脚本内置变量](../concept/script-internal-variables.md)，请将其视为一个沙盒环境，在该环境中大多数与系统相关的功能不可用。建议实现简单的操作。
-    - [Node Sandbox](https://medium.com/@devnullnor/a-secure-node-sandbox-f23b9fc9f2b0)
-    - [vm2](https://github.com/patriksimek/vm2/blob/master/README.md)
-
-## 示例脚本
-
-```
-return data['step1'].map(record => {
-  return {
-    ...record,
-    id: 'PREFIX-' + record.id
-  }
-})
-```
-
-```
-return Math.floor(Number(this.data['step2']))
-```
-
-```
-return this.data['step3'].map(record => {
-  return {
-    ...record,
-    id: (this.variables.prefix || 'DEFAULT-') + record.id
-  }
-})
-```

package/dist-app/helps/integration/task/set-domain.md

@@ -1,25 +0,0 @@
-# set-domain 태스크
-
-현재 시나리오의 컨텍스트상의 도메인을 변경한다.
-
-## 컨텍스트 도메인의 활용 예시
-
-- 컨텍스트상의 도메인은 스크립트 태스크에서 접근할 수 있다.
-
-```
-const { timezone } = this.domain
-...
-```
-
-- local-graphql-mutate, local-graphql-query의 기본 도메인으로 설정된다.
-
-- 기타 모든 태스크에서 도메인을 참조한다면, 기본적으로 이 컨텍스트상의 도메인을 참조한다.
-
-## parameters
-
-- subdomain
-  - 변경하고자하는 대상 도메인의 서브도메인 값을 입력한다.
-
-## return
-
-- 변경되기 이전 도메인의 subdomain 값을 리턴한다.

package/dist-app/helps/integration/task/sleep.md

@@ -1,8 +0,0 @@
-# sleep Task
-
-'sleep' 파라미터로 지정된 지속 시간만큼 대기하고, 지정된 시간이 만료되면 다음 태스크로 이동한다.
-
-## parameters
-
-- 지속 시간
-  - 대기해야 하는 시간을 설정한다. 단위는 밀리세컨드(ms)이다.

package/dist-app/helps/integration/task/throw.md

@@ -1,12 +0,0 @@
-# Throw
-
-Scenario 진행 중에 강제로 비정상 예외를 던지기 위한 태스크이다.
-(정상종료를 의미하는 'end' 태스크와 구분할 필요가 있다.)
-Scenario 진행 중에 Throw를 하게 되면, 해당 시나리오의 'preventErrorPropagation' 속성에 따라서, 부모 시나리오에 예외가 전파되거나 해당 시나리오에서 캐치되어 정상적으로 상위 시나리오의 태스크가 진행될 수도 있다.
-
-- preventErrorPropagation 이 true 인 경우
-  - 부모 시나리오가 있는 경우 : 해당 시나리오를 시작한 부모 'scenario' 태스크에도 예외가 전달된다. 결과적으로 부모 시나리오도 비정상 예외가 발생하게 된다.
-  - 부모 시나리오가 없는 경우 : 해당 시나리오는 시나리오 엔진에 의해 비정상 종료로 처리된다.
-- preventErrorPropagation 이 false 인 경우
-  - 부모 시나리오가 있는 경우 : 해당 시나리오를 시작한 부모 'scenario' 태스크에 예외가 전달되지 않으므로, 결과적으로 부모 시나리오도 정상적인 진행이 계속된다.
-  - 부모 시나리오가 없는 경우 : 해당 시나리오는 시나리오 엔진에 의해 정상 종료로 처리된다.

package/dist-app/helps/integration/task/variables.md

@@ -1,37 +0,0 @@
-# Variables
-
-Scenario의 입력변수를 [Scenario Context](../concept/scenario-context.md) Data에 추가하는 태스크이다.
-Variables Task는 이후 Step의 Task에서 Scenario Input 변수를 사용할 수 있도록, Scenario 시작 시에 받은 Input 변수들을 그대로 리턴하는 태스크이다.
-
-예를 들어,
-
-- Scenario Input 변수값
-
-```
-{
-  inputA: "ABC",
-  inputB: "DEF"
-}
-```
-
-이고,
-
-- Variables Task의 이름이 "VARIABLES" 인 경우,
-- Variables Task가 완료된 후에 Scenario Context의 Data에는 다음과 같은 값이 추가되게 된다.
-
-```
-# scenario.context.data
-{
-  ...,
-  VARIALBES: {
-    inputA: "ABC",
-    inputB: "DEF"
-  },
-  ...
-}
-
-```
-
-## parameters
-
-이 Task에는 별도 속성이 정의되지 않는다.

package/dist-app/helps/integration/ui/connection.md

@@ -1,31 +0,0 @@
-# Connection
-
-커넥션 페이지에서는 시나리오에서 사용될 연동 대상에 대한 커넥션 정보를 정의한다.
-
-## properties
-
-- name
-  - 커넥션의 이름을 지정
-  - 이름은 유니크해야함
-- description
-  - 커넥션에 대한 설명
-- active flag
-  - 어플리케이션 시작 시점에 자동으로 연결 여부 지정
-- connector type
-  - 연결 대상에 사용될 커넥터를 지정
-- endpoint
-  - 연결 대상의 엔드포인트 설정
-  - 커넥터별 도움말을 참고해서 설정할 수 있다.
-  - 통상, 리모트 서비스 인 경우에는 통상 {protocol}://{host}[:port] 또는 URL로 설정한다.
-  - 그리고, 대상이 로컬 파일인 경우에는 파일 패스로 설정한다.
-  - 로컬 디바이스인 경우에는 USB 포트번호가 설정될 수도 있다.
-- parameters
-  - 각 커넥터별로 엔드포인트 정보 외에 추가적인 파라미터 설정이 필요한 경우에 설정화면이 제공된다.
-  - 커넥터별 도움말을 참고해서 설정할 수 있다.
-
-## operation
-
-- connect
-  - 연결을 시도한다.
-- disconnect
-  - 연결을 종료한다.

package/dist-app/helps/integration/ui/crontab-editor.md

@@ -1,9 +0,0 @@
-# Schedule Editor
-
-- 시나리오의 자동 실행 스케쥴을 설정하는 화면이다.
-- 유닉스계열의 [cron](https://en.wikipedia.org/wiki/Cron) 명령의 설정 방식을 따른다.
-
-## 예시
-
-- '예시'는 cron 설정을 어려워하는 사용자를 위해서 다양한 스케쥴의 예시를 만들어 놓은 것이다.
-- 사용자는 유사한 스케쥴 예시를 선택하고, 그에 따라 설정된 cron의 각 항목(초, 분, 시간, 날짜, 월, 요일)을 적절하게 조정해서 의도하는 스케쥴 설정을 완료할 수 있다.

package/dist-app/helps/integration/ui/integration-monitor.md

@@ -1,29 +0,0 @@
-# Integration Monitor
-
-인티그레이션을 위한 커넥션의 연결 상태와 시나리오 실행 상태, 그리고 지연 큐에 대기 중인 시나리오 리스트를 전체적으로 모니터링 하기 위한 페이지이다.
-또한, 커넥션을 연결 및 시나리오의 실행/정지를 컨트롤 할 수 있다.
-
-## Connection (커넥션 상태)
-
-- 등록된 모든 커넥션 리스트를 커넥션 카드 형태로 볼 수 있다.
-- 커넥션의 현재 연결 상태를 표현한다.
-  - 연결 중인 커넥션은 해당 카드의 배경색이 연한 녹색으로 표현된다.
-  - 또한, 커넥션 카드의 연결/해제 버튼으로 현재 연결 여부를 판단할 수 있다.
-- 커넥션 카드의 연결/해제 버튼으로 해당 커넥션을 연결 시도하거나 해제 시킬 수 있다.
-
-## Scenario (시나리오 상태)
-
-- 등록된 모든 시나리오 리스트를 시나리오 카드 형태로 볼 수 있다.
-- 시나리오의 현재 실행 여부 상태를 표현한다.
-  - 실행 중인 시나리오는 해당 카드의 배경색이 연한 녹색으로 표현된다.
-  - 또한, 시나리오 카드의 실행/정지 버튼으로 현재 실행 여부를 판단할 수 있다.
-- 시나리오 카드의 실행/정지 버튼으로 해당 시나리오를 실행하거나 정지 시킬 수 있다.
-
-## Pending Queue (지연 큐)
-
-- 지연 큐는 bookup-scenario 태스크에 의해서 일정 시간 후에 실행될 시나리오를 등록할 수 있는 대기 큐이다.
-- 지연 큐에 보관된 지연 시나리오는 지연 시간이 만료되면 pickup-scenario 태스크에 의해서 꺼내져서 실행되게 된다.
-- 인티그레이션 모니터에서는 지연 큐에 대기 중인 시나리오의 시간 축으로 정렬된 리스트를 보여주게 된다.
-- 지연 큐에 시나리오는 시간 축상에 한 줄로 표시되며, 그 줄의 색상은 시나리오 리스트에 표현된 각 시나리오 카드 중에서 해당 시나리오의 색상과 동일하게 표현된다.
-- 지연 큐에 보관되는 시나리오는 등록시에 tag를 지정할 수 있으며, tag별로 pickup될 수 있다. 지연 큐 모니터링에서는 tag별로 선택해서 모니터링할 수 있다.
-  - tag를 '*'로 선택하면, 모든 tag의 시나리오를 모니터링하게된다.

package/dist-app/helps/integration/ui/scenario-detail.md

@@ -1,44 +0,0 @@
-# Scenario Detail
-
-시나리오 상세 정의 화면에서는 시나리오를 구성하는 스텝 리스트를 구성한다.
-
-## step
-
-스텝은 시나리오의 진행 순서대로 구성되는 단위 태스크이다.
-각 스텝의 이름(name)은 전체 시나리오의 생명주기동안 관리되는 컨텍스트 데이타를 접근하는 이름이다.
-시나리오를 구성하는 스텝은 시나리오엔진에 의해서 순서대로 수행되게되며, 특별히 플로우 컨트롤 태스크에 의해서 실행순서가 변경될 수 있다.
-
-## flow control task
-
-- end
-- goto
-- switch (switch-goto)
-- switch-range (switch-range-goto)
-- throw
-
-## properties
-
-- name
-  - 시나리오 스텝의 이름
-- description
-  - 시나리오 스텝에 대한 간략한 설명
-- result
-  - 시나리오(인스턴스) 실행결과에 포함되는 지 여부를 설정
-- skip
-  - 시나리오 실행에 포함하지 않을 지 여부를 설정
-- log
-  - 로그에 실행결과를 남길 지 여부를 설정
-- connection
-  - 커넥션 기반의 시나리오라면 설정한다. 설정하지 않으면 시나리오 엔진의 공통 태스크 중의 하나를 설정할 수 있다.
-- task
-  - 커넥션이 설정되어 있다면, 커넥션 기반의 태스크를 설정할 수 있다. 커넥션이 설정되어 있지 않으면, 시나리오 엔진의 공통 태스크 중 하나를 설정할 수 있다.
-- parameter
-  - 태스크 설정에 해당하는 파라미터를 설정
-
-## operations
-
-- add step
-- remove step
-- sequence move up / down
-- save
-- delete

package/dist-app/helps/integration/ui/scenario.md

@@ -1,35 +0,0 @@
-# Scenario
-
-시나리오 정의 화면에서는 시스템에서 운영될 시나리오를 (생성/수정/삭제/테스트) 관리한다.
-
-## properties
-
-- name
-  - 시나리오의 이름을 지정
-  - 이름은 유니크해야함
-- description
-- [schedule](./crontab-editor.md)
-- timezone
-  - 스케쥴이 운영될 기준 시간대를 설정한다.
-- active flag
-  - 어플리케이션 시작 시점에 자동으로 시작여부 지정
-- progress (모니터링중에만 표시되는 정보임)
-  - (현재 스텝 번호 / 시나리오의 전체 스텝수) %
-  - 메인 시나리오 기준이며, 서버시나리오는 하나의 스텝으로 계산된다.
-- round (모니터링중에만 표시되는 정보임)
-  - 반복되는 경우 현재 몇번째 반복횟수인지를 표현
-- message (모니터링중에만 표시되는 정보임)
-  - 시나리오 인스턴스의 최종 상태와 관련한 메시지
-
-## operations
-
-- start monitoring
-  - [인티그레이션 모니터링](./integration-monitor.md) 화면으로 이동한다.
-- copy scenario
-  - 선택된 시나리오를 복사한다
-- save scenario
-  - 시나리오 수정사항을 저장한다.
-  - 실행중 시나리오는 수정할 수 없다.
-- delete scenario
-  - 선택된 시나리오를 삭제한다.
-  - 실행중 시나리오는 삭제할 수 없다.

package/dist-app/helps/module/api.md

@@ -1,117 +0,0 @@
-# API module
-
-외부 클라이언트에 RESTful 서비스를 제공하기위한 기본 모듈이다.
-
-- openapi V3 [Swagger](https://swagger.io/) 명세를 지원한다.
-- (서버) Graphql Resolver로 구현된 기능 중에서 외부 클라이언트를 위한 RESTful API로 노출하는 패턴을 제공한다.
-- (클라이언트) API 테스트를 위한 API Sandbox를 제공한다.
-- 각 모듈별로 제공된 API 기능은 최종 Application에 통합된다.
-
-## 모듈에서 API 기능 제공하기 (기본 구조)
-
-- API를 제공하고자하는 모듈의 package.json에서 API 모듈을 dependency에 추가한다.
-- openapi 명세
-  - 각 모듈의 root 폴더에 'openapi' 라는 폴더를 만들어서 제공한다.
-  - 각 API 버전별로 {version}.yaml 파일을 생성하고 openapi V3 명세에 맞게 API 명세를 작성한다.
-  - API 내용이 많아서 하나의 파일로 작성하기 어려운 경우 openapi/{version} 폴더를 만들고, {version}.yaml 의 일부 내용을 분리해서 폴더에 추가할 수 있다.
-  - 프레임워크는 openapi/{version}.yaml 과 openapi/{version}/\*.yaml 을 모두 합해서 해당 버전의 API 명세로 이해한다.
-  - openapi/{version}.yaml 에는 openapi 명세의 공통 정의만 가지고, openapi/{verion}/{tag}.yaml 에 명세의 각 tag에 해당하는 내용을 담는 것을 추천한다.
-- 서버
-  - server/restful 폴더를 생성
-  - server/restful/{version} 폴더를 생성. 버전은 API 버전을 의미하며, 'unstable', 'v1', 'v2' 식으로 네이밍할 수 있다.
-  - server/restful/{version} 폴더에 구현될 API는 @things-factory/api 모듈에서 정의한 restfulApiRouter에 endpoint를 추가하는 방법으로 정의한다.
-  - 'get', 'post', 'put', 'delete' 메쏘드를 각 API의 의미에 맞게 사용할 것을 권장한다. (get => retrieve, post => create, put => update, delete => delete)
-- 클라이언트
-  - 각 모듈 또는 어플리케이션의 client/api/api-sandbox-{version}.js 에 구현할 것을 권장한다.
-  - 현재는 이 페이지에 APIS 명세를 별도로 정의하고 있으나, 향후 openapi 명세를 활용하는 것으로 통합될 예정이다.
-
-## 클라이언트 사이드 기능
-
-### 클라이언트 라우팅
-
-- 클라이언트 페이지명 : 'api-swagger'
-  - 'api-swagger' 페이지로 이동하면, openapi 명세에 기반한 swagger 페이지를 볼 수 있으며, 샌드박스 테스트를 해볼 수 있다.
-
-### APIPageTemplate
-
-- API 샌드박스 구성 시에 활용.
-- APIPageTemplate
-
-```
-import { APIPageTemplate } from '@things-factory/api'
-
-const APIS = [
-  {
-    name: 'scenario',
-    path: 'scenario/:id',
-    method: 'get',
-    parameters: [],
-    description: 'get scenario information'
-  }
-]
-
-class APISandbox extends APIPageTemplate {
-  constructor() {
-    super()
-  }
-
-  get APIS() {
-    return APIS
-  }
-
-  get context() {
-    return {
-      title: 'API Sandbox',
-      apiCategory: 'Integration',
-      description: 'Scenario control, connection control, ...'
-    }
-  }
-}
-
-window.customElements.define('api-sandbox', APISandbox)
-```
-
-## 서버 사이드 기능
-
-- RESTful API router
-  - 외부 클라이언트에 RESTful 엔드포인트를 제공
-  - 내부적으로는 Graphql Resolver를 호출하여 그 결과를 외부 클라이언트에 제공하는 패턴을 권장
-  - endpoint 패턴
-    - '/api/{version}/...'
-
-```
-/* API implementation sample */
-
-import gql from 'graphql-tag'
-import { restfulApiRouter as router } from '@things-factory/api'
-
-/* restfulApiRouter의 prefix가 '/api' 이므로, 그 이후의 path를 지정 */
-router.get('/unstable/scenario/:id', async (context, next) => {
-  const { client } = context.state
-  const { id } = context.params
-
-  context.body = await client.query({
-    query: gql`
-      query($id: String!) {
-        scenario(id: $id) {
-          id
-          name
-          description
-        }
-      }
-    `,
-    variables: {
-      id
-    },
-    context
-  })
-})
-```
-
-## Swagger API Page 제공
-
-- about [Swagger](https://swagger.io/)
-- [/api-docs](/api-docs)
-  - 시스템의 대표 버전의 API 도큐먼트(Swagger) 페이지로 redirect됨
-- [/api-docs/{version}](/api-docs/{version})
-  - 시스템의 해당 버전의 API 도큐먼트(Swagger) 페이지를 제공함