b2122c4073
* docs: fixes and refactoring for API reference * add route caching * remove caching * use next cache
63 lines
1.4 KiB
TypeScript
63 lines
1.4 KiB
TypeScript
import { Document, ParsedPathItemObject, SchemaObject } from "@/types/openapi"
|
|
import OpenAPIParser from "@readme/openapi-parser"
|
|
|
|
type Options = {
|
|
basePath: string
|
|
paths?: ParsedPathItemObject[]
|
|
schemas?: SchemaObject[]
|
|
}
|
|
|
|
export default async function dereference({
|
|
basePath,
|
|
paths,
|
|
schemas,
|
|
}: Options): Promise<Document> {
|
|
// dereference the references in the paths
|
|
let document: Document = {
|
|
paths: {},
|
|
// These attributes are only for validation purposes
|
|
openapi: "3.0.0",
|
|
info: {
|
|
title: "Medusa API",
|
|
version: "1.0.0",
|
|
},
|
|
components: {
|
|
schemas: {},
|
|
},
|
|
}
|
|
|
|
if (paths) {
|
|
paths.forEach((path) => {
|
|
const documentPath = path.operationPath || ""
|
|
delete path.operationPath
|
|
document.paths[documentPath] = path
|
|
})
|
|
}
|
|
|
|
if (schemas) {
|
|
schemas.forEach((schema) => {
|
|
if (!schema["x-schemaName"]) {
|
|
return
|
|
}
|
|
document.components!.schemas![schema["x-schemaName"]] = schema
|
|
})
|
|
}
|
|
|
|
// resolve references in paths
|
|
document = (await OpenAPIParser.dereference(`${basePath}/`, document, {
|
|
parse: {
|
|
text: {
|
|
// This ensures that all files are parsed as expected
|
|
// resolving the error with incorrect new lines for
|
|
// example files having `undefined` extension.
|
|
canParse: /.*/,
|
|
},
|
|
},
|
|
dereference: {
|
|
circular: "ignore",
|
|
},
|
|
})) as unknown as Document
|
|
|
|
return document
|
|
}
|