1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
import * as fs from "fs";
import {
OpenApiGeneratorV3,
OpenAPIRegistry,
} from "@asteasolutions/zod-to-openapi";
import * as yaml from "yaml";
import { registry as bookmarksRegistry } from "./lib/bookmarks";
import { registry as commonRegistry } from "./lib/common";
import { registry as listsRegistry } from "./lib/lists";
import { registry as tagsRegistry } from "./lib/tags";
function getOpenApiDocumentation() {
const registry = new OpenAPIRegistry([
commonRegistry,
bookmarksRegistry,
listsRegistry,
tagsRegistry,
]);
const generator = new OpenApiGeneratorV3(registry.definitions);
return generator.generateDocument({
openapi: "3.0.0",
info: {
version: "1.0.0",
title: "Hoarder API",
description: "The API for the Hoarder app",
},
servers: [{ url: "v1" }],
});
}
function writeDocumentation() {
// OpenAPI JSON
const docs = getOpenApiDocumentation();
// YAML equivalent
const fileContent = yaml.stringify(docs);
fs.writeFileSync(`./openapi-spec.yml`, fileContent, {
encoding: "utf-8",
});
}
writeDocumentation();
|
