zadam/trilium
1
1
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-09 23:18:46 +08:00
Code Issues Projects Releases Packages Wiki Activity

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

Browse source
This commit is contained in:
Elian Doran 2025-08-20 21:36:21 +03:00 • committed by GitHub
commit 8abd3ed3f1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 4672 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

File diff suppressed because it is too large Load diff

1
apps/server/src/assets/openapi.json
View file

File diff suppressed because one or more lines are too long

7
apps/server/src/routes/api_docs.ts
View file

@ -8,7 +8,9 @@ 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 from YAML
const apiDocument = yaml.load(readFileSync(join(RESOURCE_DIR, "api-openapi.yaml"), "utf8")) as JsonObject;
app.use( app.use(
"/etapi/docs/", "/etapi/docs/",
@ -24,7 +26,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 }'
}) })
); );
} }