多克普罗伊SDK

脚本 SDK 类型 多克宝利 API——由OpenAPI spec自动生成.

安装

npm install @dokploy/sdk
# or
pnpm add @dokploy/sdk

使用量

import { client, applicationCreate, applicationOne, projectCreate } from "@dokploy/sdk";

// Configure the client with your Dokploy instance URL and API token
client.setConfig({
  baseUrl: "https://your-dokploy-instance.com/api",
  headers: {
    "x-api-key": "YOUR_API_TOKEN",
  },
});

创建工程

const { data, error } = await projectCreate({
  body: {
    name: "my-project",
    description: "My awesome project",
  },
});

部署应用程序

const { data, error } = await applicationCreate({
  body: {
    name: "my-app",
    projectId: "project-id",
  },
});

获取应用程序细节

const { data, error } = await applicationOne({
  query: { applicationId: "app-id" },
});

console.log(data?.name);

API 覆盖范围

整个Dokploy API共有524个终点:

重新生成 SDK

如果您更新 openapi.json,将 SDK 重生为:

pnpm generate

许可证

Apache 2.0 (英语)