Skip to content

✨ Infer HTTP success status code from openapi spec #50

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
mashabek wants to merge 8 commits into
base: main
Choose a base branch
from
Open

✨ Infer HTTP success status code from openapi spec #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
cee00df
🐛 Add missing support for PUT method in openApiRouter
mashabek Nov 2, 2025
1c7cf48
🐛 Remove hardcoded version number in CLI help
mashabek Nov 2, 2025
4966ad6
📝 Recommend npx installation from npm registry
mashabek Nov 2, 2025
5a36405
✨ Infer HTTP success status codes from OpenAPI spec
mashabek Nov 2, 2025
73b8e91
🐛 Fix return type to void for "No content" http responses
mashabek Nov 2, 2025
544dbfd
♻️ Refactor result check and type assertion in async handler and cont…
mashabek Dec 1, 2025
5ffc1f2
✨ Include 3xx status codes when searching for a default response code
mashabek Jan 1, 2026
d108b2b
🐛 Set a default status code before executing endpoint handler to prev…
mashabek Jan 1, 2026
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ CLI to help you set up a Node.js TypeScript project. The setup includes:

## Usage

Run directly from GitHub repo via npx:
Run directly from npm via npx:

```
Usage: npm exec --ignore-scripts -- github:AckeeCZ/create-node-app [OPTIONS]
Usage: npx @ackee/create-node-app [OPTIONS]

Options:
-d, --dir Destination directory [string] [default: "./node-app"]
Expand Down
2 changes: 1 addition & 1 deletion src/Bootstrap.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ export class Bootstrap {
}

cli = cli
.version('1.0.0')
.version()
.help()
.check(argv => {
for (const [key, val] of Object.entries(argv)) {
Expand Down
7 changes: 7 additions & 0 deletions starter/api/rest/src/view/cli/openapi/generate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,16 @@ export const run = async (argv: any): Promise<void> => {
const pathSpec = spec.paths[path]
Object.keys(pathSpec).forEach(method => {
if (pathSpec[method]?.operationId) {
const operationResponses = pathSpec[method].responses ?? {}
const responseCodes = Object.keys(operationResponses)
const successStatus = responseCodes.find(s => s.startsWith('2'))
?? responseCodes.find(s => s.startsWith('3'))
?? '200';

acc[pathSpec[method].operationId] = {
method,
path,
successStatus: parseInt(successStatus, 10),
}
}
})
Expand Down
31 changes: 25 additions & 6 deletions starter/api/rest/src/view/rest/util/openapi.util.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,11 +126,25 @@ export type ApiHandler<TRes> = (
) => TRes | Promise<TRes>

const asyncHandler =
<TRes>(fn: ApiHandler<TRes>): express.Handler =>
<TRes>(fn: ApiHandler<TRes>, operationId?: OperationIds): express.Handler =>
async (req, res, next) => {
try {
if (operationId) {
const metadata = operationPaths[operationId]
if (metadata?.successStatus) {
res.status(metadata.successStatus)
Copy link
Member

@pavelsvagr pavelsvagr Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: This will overwrite the status user set right?

Imagine having two possible success statuses for operation (200 and 2xx or 200 and 3xx) for example based on Accept header of the client request. If the dev sets the status before the async handler is called, this will overwrite it to 200.

Copy link
Collaborator Author

@mashabek mashabek Jan 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, I moved the status code assignment before we execute the operation handler, so anything set by user will overwrite it.

}
}

const result = await fn(req.context, req, res)
res.json(result)

if (!res.headersSent) {
if (result != undefined) {
res.json(result)
} else {
res.end()
}
}
} catch (error: unknown) {
next(error)
}
Expand Down Expand Up @@ -158,7 +172,7 @@ type MimeContentValue<
type OpenApiContentTypes<OpenApiContent extends Record<number, any>> = {
[K in keyof OpenApiContent]: OpenApiContent[K] extends Content
? MimeContentValue<ApiMimeTypes, OpenApiContent[K]>
: never
: void
}[keyof OpenApiContent]

export type OperationParams<OperationId extends OperationIds> =
Expand Down Expand Up @@ -200,8 +214,9 @@ export type RestApiController<
}

const handleOperationAsync = <OperationId extends OperationIds>(
fn: OperationHandler<OperationId>
): OpenApiHandler<OperationId> => asyncHandler(fn as any) as any
fn: OperationHandler<OperationId>,
operationId: OperationId
): OpenApiHandler<OperationId> => asyncHandler(fn as any, operationId) as any

const createRestController = <SubsetOperationIds extends OperationIds>(
def: RouteHandlers<SubsetOperationIds>
Expand All @@ -211,7 +226,8 @@ const createRestController = <SubsetOperationIds extends OperationIds>(
return ctrl
}
ctrl[operationId as SubsetOperationIds] = handleOperationAsync(
handler as any
handler as any,
operationId as SubsetOperationIds
) as any
return ctrl
}, {} as RestApiController<SubsetOperationIds>)
Expand Down Expand Up @@ -245,6 +261,9 @@ export const openApiRouter = (
case 'post':
router.post(route, handler)
break
case 'PUT':
router.put(route, handler)
break
case 'patch':
router.patch(route, handler)
break
Expand Down