mirror of
https://github.com/Dokploy/dokploy.git
synced 2026-06-18 13:45:23 +02:00
aab982b431
- Introduced a new script to generate OpenAPI specifications for the Dokploy API. - Added a GitHub Actions workflow to automate the generation and syncing of OpenAPI documentation upon changes in the API routers. - Updated package.json files to include new commands for generating OpenAPI specifications. - Added openapi.json to .gitignore to prevent accidental commits of generated files.
133 lines
3.0 KiB
TypeScript
133 lines
3.0 KiB
TypeScript
#!/usr/bin/env tsx
|
|
|
|
/**
|
|
* Script to generate OpenAPI specification locally
|
|
* This runs in CI/CD to generate the openapi.json file
|
|
* which can then be consumed by the documentation website
|
|
*/
|
|
|
|
import { writeFileSync } from "node:fs";
|
|
import { dirname, resolve } from "node:path";
|
|
import { fileURLToPath } from "node:url";
|
|
import { generateOpenApiDocument } from "@dokploy/trpc-openapi";
|
|
import { appRouter } from "../server/api/root";
|
|
|
|
const __filename = fileURLToPath(import.meta.url);
|
|
const __dirname = dirname(__filename);
|
|
|
|
async function generateOpenAPI() {
|
|
try {
|
|
console.log("🔄 Generating OpenAPI specification...");
|
|
|
|
const openApiDocument = generateOpenApiDocument(appRouter, {
|
|
title: "Dokploy API",
|
|
version: "1.0.0",
|
|
baseUrl: "https://your-dokploy-instance.com/api",
|
|
docsUrl: "https://docs.dokploy.com/api",
|
|
tags: [
|
|
"admin",
|
|
"docker",
|
|
"compose",
|
|
"registry",
|
|
"cluster",
|
|
"user",
|
|
"domain",
|
|
"destination",
|
|
"backup",
|
|
"deployment",
|
|
"mounts",
|
|
"certificates",
|
|
"settings",
|
|
"security",
|
|
"redirects",
|
|
"port",
|
|
"project",
|
|
"application",
|
|
"mysql",
|
|
"postgres",
|
|
"redis",
|
|
"mongo",
|
|
"mariadb",
|
|
"sshRouter",
|
|
"gitProvider",
|
|
"bitbucket",
|
|
"github",
|
|
"gitlab",
|
|
"gitea",
|
|
"server",
|
|
"swarm",
|
|
"ai",
|
|
"organization",
|
|
"schedule",
|
|
"rollback",
|
|
"volumeBackups",
|
|
"environment",
|
|
],
|
|
});
|
|
|
|
// Enhance metadata
|
|
openApiDocument.info = {
|
|
title: "Dokploy API",
|
|
description:
|
|
"Complete API documentation for Dokploy - Deploy applications, manage databases, and orchestrate your infrastructure. This API allows you to programmatically manage all aspects of your Dokploy instance.",
|
|
version: "1.0.0",
|
|
contact: {
|
|
name: "Dokploy Team",
|
|
url: "https://dokploy.com",
|
|
},
|
|
license: {
|
|
name: "Apache 2.0",
|
|
url: "https://github.com/dokploy/dokploy/blob/canary/LICENSE",
|
|
},
|
|
};
|
|
|
|
// Add security schemes
|
|
openApiDocument.components = {
|
|
...openApiDocument.components,
|
|
securitySchemes: {
|
|
apiKey: {
|
|
type: "apiKey",
|
|
in: "header",
|
|
name: "x-api-key",
|
|
description:
|
|
"API key authentication. Generate an API key from your Dokploy dashboard under Settings > API Keys.",
|
|
},
|
|
},
|
|
};
|
|
|
|
// Apply global security
|
|
openApiDocument.security = [
|
|
{
|
|
apiKey: [],
|
|
},
|
|
];
|
|
|
|
// Add external docs
|
|
openApiDocument.externalDocs = {
|
|
description: "Full documentation",
|
|
url: "https://docs.dokploy.com",
|
|
};
|
|
|
|
// Write to root of repo
|
|
const outputPath = resolve(__dirname, "../../../openapi.json");
|
|
writeFileSync(
|
|
outputPath,
|
|
JSON.stringify(openApiDocument, null, 2),
|
|
"utf-8",
|
|
);
|
|
|
|
console.log("✅ OpenAPI specification generated successfully!");
|
|
console.log(`📄 Output: ${outputPath}`);
|
|
console.log(
|
|
`📊 Endpoints: ${Object.keys(openApiDocument.paths || {}).length}`,
|
|
);
|
|
} catch (error) {
|
|
console.error("❌ Error generating OpenAPI specification:", error);
|
|
process.exit(1);
|
|
} finally {
|
|
process.exit(0);
|
|
}
|
|
}
|
|
|
|
generateOpenAPI();
|