跳到主要内容

编辑器服务

WIKI 接入新页面节点类型插件的编辑器服务开发分为三步：

  • 独立应用开发
  • 添加 WIKI 新页面类型插槽
  • 添加托管独立应用能力

独立应用开发​

第一步：编写独立应用管理脚本​

例如，独立应用可执行程序名字为：GrapeCityServer

workspace/start.sh
#!/bin/bash
usage() {
    echo -e "Usage: $(basename $0) [options]"
    echo -e " 启动"

    exit 1
}
# 处理启动服务
start() {
    echo "/usr/bin/nohup ./GrapeCityServer --port=$PARAMS_PORT --args=$ARGS >/dev/null 2>&1 &"
    /usr/bin/nohup ./GrapeCityServer --port=$PARAMS_PORT --args=$ARGS > nohup.out 2>&1 &
}
# 处理停止服务
stop() {
  # 这里的 pid.txt 必须和服务内部保持一致
  echo "kill -9 $(cat pid.txt)"
  kill -9 "$(cat pid.txt)"
}
parse_config() {
    for arg in ${ARGS}
    do
        case ${arg} in
            --port=*)
                PARAMS_PORT=${arg#*=}
                ;;
            --path=*)
                PATH=${arg#*=}
                ;;
            --args=*)
                ARGS=${arg#*=}
                ;;
        esac
    done
}
ARGS="$@"
# 申明指令！！！(这里是入口)
parse_config
case $1 in
help) usage;;
start) start;;
stop) stop;;
*) usage;;
esac

第二步：按照独立应用程序编写​

//Goland
package main

var (
	port int
	args string
)

func initFlags() {
	flag.IntVar(&port, "port", 18000, "service port")
	flag.StringVar(&args, "args", "", "service other parameters")
	flag.Parse()
	parse_other_args()
}

func parse_other_args() {
    //将传入的args字符串按照规范进行解析，规范可自定义，但在设计中args字符串中不可有空白符
}

//独立应用保存进程PID
func savePid() {
	pid := os.Getpid()
	log.Infof("process PID: %d \n", pid)

	err := os.WriteFile("./pid.txt", []byte(strconv.Itoa(pid)), 0644)
	if err != nil {
		log.Fatalf("Logging PID failed: %+v", err)
	}
}

func main() {
    //解析参数
	initFlags()
        savePid()

    //...
    //启动web service
	addr := fmt.Sprintf("%s:%d", "localhost", port)
    // router.Run 函数可参见步骤3
	err := router.Run(addr)
	if err != nil {
		log.Fatal("start service fail")
	}
}

第三步：按照Editor Server规范实现独立服务相关的接口​

自定义Editor Server服务需要支持http、websocket方法，主要包括：

//Goland
package router

func Run(addr string) error {
	gin.SetMode(gin.ReleaseMode)
	app := gin.New()

	//http request
	app.POST("/getToken", controllers.GetToken)

	//websocket request
	app.GET("/edit", controllers.Edit)

	return app.Run(addr)
}

第四步：编译成可执行文件，并验证可执行文件的兼容性​

添加 WIKI 新页面类型插槽​

开发插槽，可能需要获取独立应用（Editor Server）url 地址。下面详细给出，获取获取独立服务地址信息的接口：

获取独立服务的地址信​

根据插件的 app_id 获取独立服务地址信息。

URL​

https://{your-host-name}/project/api/project/plugin/web_service/info

HTTP Method​

POST

是否需要登录​

是

传值方式​

JSON

参数列表​

Header

参数名是否必须值类型取值例子说明
Content-TypeTstringapplication/jsonJSON 格式的数据
Ones-Check-PointTstringteam固定值
Ones-Plugin-IdTstringbuilt_in_apis固定值
Ones-Check-IdTstringATVswGgyteam_uuid，用于校验
Ones-User-IdTstring4qumKXgMuser_uuid，用于校验
OriginFstringhttps://xxxx.comONES的Base地址

Body

参数名是否必须值类型取值例子说明
app_idTstring"Xy4-EYjw"插件的app_id信息
base_urlFstringhttps://xxxx.comONES的Base地址。优先使用该字段，为空则会使用Header中Origin字段

返回参数列表​

参数名值类型取值例子说明
data[]object参见data对象返回data数组数据

data 对象

参数名值类型取值例子说明
app_idstringXy4-EYjw插件的app_id信息
root_routestring/node_demo托管独立服务跟路由信息
http_urlstringhttps://xxx.com/node_demo托管独立服务http地址
ws_urlstringwss://xxx.com/node_demo托管独立服务websocket地址

请求体示例​

curl --location --request POST 'https://xxx.com/project/api/project/plugin/web_service/info' \
--header 'Ones-Check-Id: ATVswGgy' \
--header 'Ones-Check-Point: team' \
--header 'Ones-Plugin-Id: built_in_apis' \
--header 'Ones-User-Id: 4qumKXgM' \
--header 'Content-Type: application/json' \
--header 'Origin: https://xxx.com/' \
--data-raw '{
    "app_id":"VGh6Y6N"
}'

返回示例​

{
  "data": [
    {
      "app_id": "VGh6Y6N",
      "root_route": "/hello",
      "http_url": "https://xxx.com/plugin_service/hello",
      "ws_url": "wss://xxx.com/api/plugin_service_ws/hello"
    }
  ]
}

添加托管独立应用能力​

配置如下所示：可按需修改配置

config/plugin.yaml
abilities:
  - id: xxxxxxxx
    name: xxxxxxx_GrapeCityServer
    abilityType: web_service
    version: 1.0.0
    config:
      - fieldType: Input
        key: root_route
        show: false
        value: /GrapeCityServer
      - fieldType: Input
        key: args
        show: true
        value: ''
      - fieldType: Input
        key: start_file
        show: false
        value: start.sh
      - fieldType: Switch
        key: is_open
        show: false
        value: true
最后由 ones-dev-jenkins 于 更新