gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-20 23:29:02 +02:00
Code Issues Actions 18 Packages Projects Releases Wiki Activity

feat(docs): implement swagger ui endpoint for internal api

Browse Source
This commit is contained in:
perf3ct 2025-08-20 17:11:54 +00:00
parent 8752182e7e
commit f9a3606ca2
No known key found for this signature in database
GPG Key ID: 569C4EEC436F5232
2 changed files with 4126 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4112
apps/server/src/assets/api-openapi.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

17
apps/server/src/routes/api_docs.ts
View File

@ -3,12 +3,22 @@ import swaggerUi from "swagger-ui-express";
import { join } from "path"; import { join } from "path";
import yaml from "js-yaml"; import yaml from "js-yaml";
import type { JsonObject } from "swagger-ui-express"; import type { JsonObject } from "swagger-ui-express";
import { readFileSync } from "fs"; import { readFileSync, existsSync } from "fs";
import { RESOURCE_DIR } from "../services/resource_dir"; import { RESOURCE_DIR } from "../services/resource_dir";
export default function register(app: Application) { export default function register(app: Application) {
const etapiDocument = yaml.load(readFileSync(join(RESOURCE_DIR, "etapi.openapi.yaml"), "utf8")) as JsonObject; const etapiDocument = yaml.load(readFileSync(join(RESOURCE_DIR, "etapi.openapi.yaml"), "utf8")) as JsonObject;
const apiDocument = JSON.parse(readFileSync(join(RESOURCE_DIR, "openapi.json"), "utf-8"));
// Load the comprehensive API documentation (YAML) if available, otherwise fall back to JSON
const apiYamlPath = join(RESOURCE_DIR, "api-openapi.yaml");
const apiJsonPath = join(RESOURCE_DIR, "openapi.json");
let apiDocument: JsonObject;
if (existsSync(apiYamlPath)) {
apiDocument = yaml.load(readFileSync(apiYamlPath, "utf8")) as JsonObject;
} else {
apiDocument = JSON.parse(readFileSync(apiJsonPath, "utf-8"));
}
app.use( app.use(
"/etapi/docs/", "/etapi/docs/",
@ -24,7 +34,8 @@ export default function register(app: Application) {
swaggerUi.serveFiles(apiDocument), swaggerUi.serveFiles(apiDocument),
swaggerUi.setup(apiDocument, { swaggerUi.setup(apiDocument, {
explorer: true, explorer: true,
customSiteTitle: "TriliumNext Internal API Documentation" customSiteTitle: "TriliumNext Internal API Documentation",
customCss: '.swagger-ui .topbar { display: none }'
}) })
); );
} }