Spaces:
Runtime error
Runtime error
File size: 5,962 Bytes
cd8bd0a | 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 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | import { readFileSync, writeFileSync } from "node:fs";
import { apiFetch } from "../api.mjs";
import { emit } from "../output.mjs";
import { t } from "../i18n.mjs";
function truncate(v, max = 40) {
if (!v) return "-";
const s = String(v);
return s.length > max ? s.slice(0, max - 1) + "…" : s;
}
function toYaml(obj, indent = 0) {
const pad = " ".repeat(indent);
if (obj === null || obj === undefined) return "null";
if (typeof obj === "boolean") return String(obj);
if (typeof obj === "number") return String(obj);
if (typeof obj === "string") {
if (/[\n:#{}[\],&*?|<>=!%@`]/.test(obj) || obj.trim() !== obj) {
return JSON.stringify(obj);
}
return obj || '""';
}
if (Array.isArray(obj)) {
if (obj.length === 0) return "[]";
return obj.map((v) => `\n${pad}- ${toYaml(v, indent + 1)}`).join("");
}
const entries = Object.entries(obj);
if (entries.length === 0) return "{}";
return entries
.map(([k, v]) => {
const safeKey = /[^a-zA-Z0-9_-]/.test(k) ? JSON.stringify(k) : k;
if (v !== null && typeof v === "object") {
const nested = toYaml(v, indent + 1);
if (Array.isArray(v) && v.length > 0) return `\n${pad}${safeKey}:${nested}`;
if (!Array.isArray(v) && Object.keys(v).length > 0) return `\n${pad}${safeKey}:\n${nested}`;
return `\n${pad}${safeKey}: ${nested}`;
}
return `\n${pad}${safeKey}: ${toYaml(v, indent + 1)}`;
})
.join("")
.trimStart();
}
function validateBasic(spec) {
if (!spec || typeof spec !== "object") throw new Error("spec is not an object");
if (!spec.openapi && !spec.swagger) throw new Error("missing openapi/swagger version field");
if (!spec.info) throw new Error("missing info object");
if (!spec.paths) throw new Error("missing paths object");
}
const endpointSchema = [
{ key: "method", header: "Method", width: 8 },
{ key: "path", header: "Path", width: 45 },
{ key: "operationId", header: "Operation ID", width: 25 },
{ key: "summary", header: "Summary", width: 40, formatter: (v) => truncate(v, 40) },
];
export function registerOpenapi(program) {
const api = program.command("openapi").description(t("openapi.description"));
api
.command("dump")
.description(t("openapi.dump.description"))
.option("--format <f>", t("openapi.dump.format"), "yaml")
.option("--out <path>", t("openapi.dump.out"))
.action(async (opts, cmd) => {
const res = await apiFetch("/api/openapi/spec");
if (!res.ok) {
process.stderr.write(`Error: ${res.status}\n`);
process.exit(1);
}
const data = await res.json();
const serialized =
opts.format === "yaml" ? toYaml(data) + "\n" : JSON.stringify(data, null, 2);
if (opts.out) {
writeFileSync(opts.out, serialized);
process.stdout.write(`Saved to ${opts.out}\n`);
} else {
process.stdout.write(serialized);
}
});
api
.command("validate")
.description(t("openapi.validate.description"))
.action(async (opts, cmd) => {
const res = await apiFetch("/api/openapi/spec");
if (!res.ok) {
process.stderr.write(`Error: ${res.status}\n`);
process.exit(1);
}
const spec = await res.json();
try {
validateBasic(spec);
process.stdout.write("Spec is valid\n");
} catch (err) {
process.stderr.write(`Invalid: ${err.message}\n`);
process.exit(1);
}
});
api
.command("try <path>")
.description(t("openapi.try.description"))
.option("--method <m>", t("openapi.try.method"), "GET")
.option("--body <file>", t("openapi.try.body"))
.option("--query <kv>", t("openapi.try.query"), (v, prev = []) => [...prev, v.split("=")], [])
.option("--header <kv>", t("openapi.try.header"), (v, prev = []) => [...prev, v.split("=")], [])
.action(async (path, opts, cmd) => {
const body = opts.body ? JSON.parse(readFileSync(opts.body, "utf8")) : undefined;
const query = Object.fromEntries(opts.query ?? []);
const headers = Object.fromEntries(opts.header ?? []);
const res = await apiFetch("/api/openapi/try", {
method: "POST",
body: { path, method: opts.method, body, query, headers },
});
if (!res.ok) {
process.stderr.write(`Error: ${res.status}\n`);
process.exit(1);
}
emit(await res.json(), cmd.optsWithGlobals());
});
api
.command("endpoints")
.description(t("openapi.endpoints.description"))
.option("--search <q>", t("openapi.endpoints.search"))
.action(async (opts, cmd) => {
const res = await apiFetch("/api/openapi/spec");
if (!res.ok) {
process.stderr.write(`Error: ${res.status}\n`);
process.exit(1);
}
const spec = await res.json();
const rows = [];
for (const [path, methods] of Object.entries(spec.paths ?? {})) {
for (const [method, def] of Object.entries(methods)) {
if (["parameters", "summary"].includes(method)) continue;
const summary = def.summary ?? def.description ?? "";
if (
opts.search &&
!path.includes(opts.search) &&
!summary.toLowerCase().includes(opts.search.toLowerCase())
)
continue;
rows.push({ method: method.toUpperCase(), path, summary, operationId: def.operationId });
}
}
emit(rows, cmd.optsWithGlobals(), endpointSchema);
});
api
.command("paths")
.description(t("openapi.paths.description"))
.action(async (opts, cmd) => {
const res = await apiFetch("/api/openapi/spec");
if (!res.ok) {
process.stderr.write(`Error: ${res.status}\n`);
process.exit(1);
}
const spec = await res.json();
const paths = Object.keys(spec.paths ?? {}).sort();
emit(
paths.map((p) => ({ path: p })),
cmd.optsWithGlobals()
);
});
}
|