orbitapi-plugin-sdk

module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 7, 2025 License: MIT

README

API Plugin SDK

Go Report Card GoDoc

API Plugin SDK 是一个用于开发和管理插件的工具包,支持插件的生命周期管理、配置管理、通信等核心功能。

特性

  • 插件生命周期管理(安装、启动、停止、卸载)
  • HTTP 通信协议支持
  • 配置管理与热更新
  • 安全认证与加密通信
  • 版本管理与兼容性检查

快速开始

安装
go get github.com/orbit-center/orbitapi-plugin-sdk
基本使用
package main

import (
    "github.com/orbit-center/orbitapi-plugin-sdk/interfaces"
    "github.com/orbit-center/orbitapi-plugin-sdk/manager"
)

func main() {
    // 创建插件管理器
    manager := manager.NewLifecycleManager()

    // 注册插件
    plugin := NewMyPlugin()
    err := manager.RegisterPlugin(plugin)
    if err != nil {
        log.Fatal(err)
    }

    // 启动插件
    err = manager.StartPlugin(plugin.GetInfo().Name, config)
    if err != nil {
        log.Fatal(err)
    }
}

更多示例请查看 examples 目录。

文档

示例项目

贡献指南

  1. Fork 项目
  2. 创建特性分支 (git checkout -b feature/amazing-feature)
  3. 提交更改 (git commit -m 'Add some amazing feature')
  4. 推送到分支 (git push origin feature/amazing-feature)
  5. 创建 Pull Request

许可证

本项目采用 MIT 许可证 - 详见 LICENSE 文件

维护者

致谢

感谢所有贡献者对项目的支持!

Directories

Path Synopsis
Package config 提供配置管理功能
Package config 提供配置管理功能
examples
Package interfaces 定义了插件 SDK 的核心接口
Package interfaces 定义了插件 SDK 的核心接口
Package manager 提供插件生命周期管理功能
Package manager 提供插件生命周期管理功能
Package utils 提供通用工具函数
Package utils 提供通用工具函数

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL