insomnia/packages/insomnia-app/app/common/api-specs.ts

43 lines
991 B
TypeScript
Raw Normal View History

2020-04-26 20:33:39 +00:00
import YAML from 'yaml';
export interface ParsedApiSpec {
contents: Record<string, any> | null;
rawContents: string;
format: 'openapi' | 'swagger' | null;
formatVersion: string | null;
}
export function parseApiSpec(
rawDocument: string,
) {
const result: ParsedApiSpec = {
2020-04-26 20:33:39 +00:00
contents: null,
rawContents: rawDocument,
format: null,
formatVersion: null,
};
// NOTE: JSON is valid YAML so we only need to parse YAML
try {
result.contents = YAML.parse(rawDocument);
} catch (err) {
throw new Error('Failed to parse API spec');
}
if (result.contents) {
if (result.contents.openapi) {
// Check if it's OpenAPI
result.format = 'openapi';
result.formatVersion = result.contents.openapi;
} else if (result.contents.swagger) {
// Check if it's Swagger
result.format = 'swagger';
result.formatVersion = result.contents.swagger;
} else {
// Not sure what format it is
}
}
return result;
}