-
Notifications
You must be signed in to change notification settings - Fork 35
/
openApiSpecFactory.ts
73 lines (67 loc) · 2.26 KB
/
openApiSpecFactory.ts
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
import fs from 'fs-extra';
import yaml from 'js-yaml';
import OpenAPISchemaValidator from 'openapi-schema-validator';
import type { OpenAPI, OpenAPIV2, OpenAPIV3 } from 'openapi-types';
import path from 'path';
import typeOf from 'typeof';
import OpenApi2Spec from './classes/OpenApi2Spec';
import OpenApi3Spec from './classes/OpenApi3Spec';
import { stringify } from './utils/common.utils';
type AnyObject = Record<string, unknown>;
const isObject = (arg: unknown): arg is AnyObject =>
typeof arg === 'object' && arg !== null && !Array.isArray(arg);
export default function makeApiSpec(
filepathOrObject: string | OpenAPI.Document,
): OpenApi2Spec | OpenApi3Spec {
const spec = loadSpec(filepathOrObject);
validateSpec(spec);
const validSpec = spec as OpenAPI.Document;
if ('swagger' in validSpec) {
return new OpenApi2Spec(validSpec);
}
return new OpenApi3Spec(validSpec as OpenAPIV3.Document);
}
function loadSpec(arg: unknown): AnyObject {
try {
if (typeof arg === 'string') {
return loadFile(arg);
}
if (isObject(arg)) {
return arg;
}
throw new Error(`Received type '${typeOf(arg)}'`);
} catch (error) {
throw new Error(
`The provided argument must be either an absolute filepath or an object representing an OpenAPI specification.\nError details: ${
(error as Error).message
}`,
);
}
}
function loadFile(filepath: string): AnyObject {
if (!path.isAbsolute(filepath)) {
throw new Error(`'${filepath}' is not an absolute filepath`);
}
const fileData = fs.readFileSync(filepath, { encoding: 'utf8' });
try {
return yaml.load(fileData) as AnyObject;
} catch (error) {
throw new Error(`Invalid YAML or JSON:\n${(error as Error).message}`);
}
}
function validateSpec(obj: AnyObject): OpenAPI.Document {
try {
const validator = new OpenAPISchemaValidator({
version:
(obj as unknown as OpenAPIV2.Document).swagger || // '2.0'
(obj as unknown as OpenAPIV3.Document).openapi, // '3.X.X'
});
const { errors } = validator.validate(obj as OpenAPI.Document);
if (errors.length > 0) {
throw new Error(stringify(errors));
}
return obj as OpenAPI.Document;
} catch (error) {
throw new Error(`Invalid OpenAPI spec: ${(error as Error).message}`);
}
}