Tools/Notes
1
0
Fork 0
mirror of https://github.com/TriliumNext/Notes.git synced 2025-07-27 18:12:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat(docs): internal API docs

Browse Source
This commit is contained in:
Elian Doran 2025-02-15 00:25:23 +02:00
parent 81d5d16e1a
commit 9299f90b85
No known key found for this signature in database
4 changed files with 31 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
bin/copy-dist.ts
View File

@ -29,7 +29,12 @@ const copy = async () => {
fs.copySync(path.join("build", srcFile), destFile, { recursive: true }); fs.copySync(path.join("build", srcFile), destFile, { recursive: true });
} }
const filesToCopy = ["config-sample.ini", "tsconfig.webpack.json", "./src/etapi/etapi.openapi.yaml"]; const filesToCopy = [
"config-sample.ini",
"tsconfig.webpack.json",
"./src/etapi/etapi.openapi.yaml",
"./src/routes/api/openapi.json"
];
for (const file of filesToCopy) { for (const file of filesToCopy) {
log(`Copying ${file}`); log(`Copying ${file}`);
await fs.copy(file, path.join(DEST_DIR, file)); await fs.copy(file, path.join(DEST_DIR, file));

9
bin/generate-openapi.ts
View File

@ -1,4 +1,7 @@
import { fileURLToPath } from "url";
import { dirname, join } from "path";
import swaggerJsdoc from 'swagger-jsdoc'; import swaggerJsdoc from 'swagger-jsdoc';
import fs from "fs";
/* /*
* Usage: npm run generate-openapi | tail -n1 > x.json * Usage: npm run generate-openapi | tail -n1 > x.json
@ -33,8 +36,10 @@ const options = {
}; };
const openapiSpecification = swaggerJsdoc(options); const openapiSpecification = swaggerJsdoc(options);
const scriptDir = dirname(fileURLToPath(import.meta.url));
console.log(JSON.stringify(openapiSpecification)); const outputPath = join(scriptDir, "..", "src", "routes", "api", "openapi.json");
fs.writeFileSync(outputPath, JSON.stringify(openapiSpecification));
console.log("Saved to ", outputPath);
/** /**
* @swagger * @swagger

1
src/routes/api/openapi.json Normal file
View File

File diff suppressed because one or more lines are too long

24
src/routes/api_docs.ts
View File

@ -1,4 +1,4 @@
import type { Router } from "express"; import type { Application, Router } from "express";
import swaggerUi from "swagger-ui-express"; import swaggerUi from "swagger-ui-express";
import { readFile } from "fs/promises"; import { readFile } from "fs/promises";
import { fileURLToPath } from "url"; import { fileURLToPath } from "url";
@ -7,19 +7,29 @@ import yaml from "js-yaml";
import type { JsonObject } from "swagger-ui-express"; import type { JsonObject } from "swagger-ui-express";
const __dirname = dirname(fileURLToPath(import.meta.url)); const __dirname = dirname(fileURLToPath(import.meta.url));
const swaggerDocument = yaml.load( const etapiDocument = yaml.load(
await readFile(join(__dirname, "../etapi/etapi.openapi.yaml"), "utf8") await readFile(join(__dirname, "../etapi/etapi.openapi.yaml"), "utf8")
) as JsonObject; ) as JsonObject;
const apiDocument = JSON.parse(await readFile(join(__dirname, "api", "openapi.json"), "utf-8"));
function register(router: Router) { function register(app: Application) {
router.use( app.use(
"/etapi", "/etapi/docs/",
swaggerUi.serve, swaggerUi.serveFiles(etapiDocument),
swaggerUi.setup(swaggerDocument, { swaggerUi.setup(etapiDocument, {
explorer: true, explorer: true,
customSiteTitle: "TriliumNext ETAPI Documentation" customSiteTitle: "TriliumNext ETAPI Documentation"
}) })
); );
app.use(
"/api/docs/",
swaggerUi.serveFiles(apiDocument),
swaggerUi.setup(apiDocument, {
explorer: true,
customSiteTitle: "TriliumNext Internal API Documentation"
})
);
} }
export default { export default {