@unleash/proxy/src/openapi/openapi-service.ts

The Unleash Proxy (Open-Source)

import openapi, { type IExpressOpenApi } from '@wesleytodd/openapi';
import type { Application, RequestHandler } from 'express';
import type { OpenAPIV3 } from 'openapi-types';
import { createOpenApiSchema } from '.';
import type { IProxyConfig } from '../config';
import { format500ErrorMessage } from './common-responses';

export class OpenApiService {
    private readonly config: IProxyConfig;

    private readonly api: IExpressOpenApi;

    constructor(config: IProxyConfig) {
        this.config = config;
        this.api = openapi(
            this.docsPath(),
            createOpenApiSchema(
                config.proxyBasePath,
                config.clientKeysHeaderName,
            ),
            { coerce: true },
        );
    }

    docsPath(): string {
        return `${this.config.proxyBasePath}/docs/openapi`;
    }

    // Serve the OpenAPI JSON at `${this.docsPath()}.json`,
    // and the OpenAPI SwaggerUI at `${this.docsPathPath}`.
    useDocs(app: Application): void {
        app.use(this.api);
        app.use(this.docsPath(), this.api.swaggerui());
    }

    // Create request validation middleware
    validPath(op: OpenAPIV3.OperationObject): RequestHandler {
        return this.api.validPath(op);
    }

    // Catch and format Open API validation errors.
    useErrorHandler(app: Application): void {
        app.use((err: any, _: any, res: any, next: any) => {
            if (err?.status && err.validationErrors) {
                res.status(err.statusCode).json({
                    error: err.message,
                    validation: err.validationErrors,
                });
            } else if (err instanceof SyntaxError) {
                res.status(400).json({
                    error: `We were unable to parse the data you provided. Please check it for syntax errors. The message we got was: "${err.message}"`,
                });
            } else if (err) {
                res.status(500).json({
                    error: format500ErrorMessage(err.message),
                });
            } else {
                next();
            }
        });
    }
}