Skip to content

express-openapi: extend expressJS Request Handler Parameters through express-openapi #817

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joshAg wants to merge 1 commit into
base: main
Choose a base branch
from
+23 −4
Open

express-openapi: extend expressJS Request Handler Parameters through express-openapi #817

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions packages/express-openapi/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import * as core from 'express-serve-static-core';
import { ErrorObject, FormatDefinition, Format } from 'ajv';
import { Application, ErrorRequestHandler, RequestHandler } from 'express';
import OpenAPIFramework, {
Expand All @@ -13,16 +14,34 @@ const CASE_SENSITIVE_PARAM_PROPERTY = 'x-express-openapi-case-sensitive';
const normalizeQueryParamsMiddleware = require('express-normalize-query-params-middleware');
const loggingPrefix = 'express-openapi';

export interface OperationFunction extends RequestHandler {
export interface OperationFunction<
P extends Record<string, string> = core.ParamsDictionary,
ResBody = any,
ReqBody = any,
ReqQuery = core.Query,
Locals extends Record<string, any> = Record<string, any>
> extends RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals> {
apiDoc?: OpenAPI.Operation;
}

export interface OperationHandlerArray {
export interface OperationHandlerArray<
P extends Record<string, string> = core.ParamsDictionary,
ResBody = any,
ReqBody = any,
ReqQuery = core.Query,
Locals extends Record<string, any> = Record<string, any>
> {
apiDoc?: OpenAPI.Operation;
[index: number]: RequestHandler;
[index: number]: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals>;
}

export type Operation = OperationFunction | OperationHandlerArray;
export type Operation<
P extends Record<string, string> = core.ParamsDictionary,
ResBody = any,
ReqBody = any,
ReqQuery = core.Query,
Locals extends Record<string, any> = Record<string, any>
> = OperationFunction<P, ResBody, ReqBody, ReqQuery, Locals> | OperationHandlerArray<P, ResBody, ReqBody, ReqQuery, Locals>;

export interface ExpressOpenAPIArgs extends OpenAPIFrameworkArgs {
app: Application;
Expand Down