feat: requestBodyExample

Author: omermecitoglu

src/core/body.ts

@@ -5,12 +5,16 @@ import { safeParse } from "./zod-error-handler";
 import type { RequestBodyObject } from "@omer-x/openapi-types/request-body";
 import type { ZodError, ZodType, ZodTypeDef } from "zod";
 
-export function resolveRequestBody<I, O>(source?: ZodType<O, ZodTypeDef, I> | string, isFormData: boolean = false) {
+export function resolveRequestBody<I, O>(
+  source?: ZodType<O, ZodTypeDef, I> | string,
+  isFormData: boolean = false,
+  customExample?: O,
+) {
   if (!source) return undefined;
   return {
     // description: "", // how to fill this?
     required: true,
-    content: resolveContent(source, false, isFormData),
+    content: resolveContent(source, false, isFormData, customExample),
   } as RequestBodyObject;
 }
 

src/core/definer.ts

@@ -19,12 +19,14 @@ type ActionSource<PathParams, QueryParams, RequestBody> = {
 type RouteWithoutBody = {
   method: Extract<HttpMethod, "GET" | "DELETE" | "HEAD">,
   requestBody?: null,
+  requestBodyExample?: undefined,
   hasFormData?: boolean,
 };
 
 type RouteWithBody<I, O> = {
   method: Exclude<HttpMethod, "GET" | "DELETE" | "HEAD">,
   requestBody?: ZodType<O, ZodTypeDef, I> | string,
+  requestBodyExample?: NoInfer<O>,
   hasFormData?: boolean,
 };
 
@@ -125,7 +127,7 @@ function defineRoute<
     description: input.description,
     tags: input.tags,
     parameters: parameters.length ? parameters : undefined,
-    requestBody: resolveRequestBody(input.requestBody ?? undefined, input.hasFormData),
+    requestBody: resolveRequestBody(input.requestBody ?? undefined, input.hasFormData, input.requestBodyExample),
     responses: responses,
     security: input.security,
   };