Improve path parameter validation WIP

blomqma · Apr 13, 2024 · 8fb1816 · 8fb1816
1 parent 586205f
commit 8fb1816
Show file tree

Hide file tree

Showing 23 changed files with 617 additions and 244 deletions.
diff --git a/apps/example/public/openapi.json b/apps/example/public/openapi.json
diff --git a/apps/example/src/actions.ts b/apps/example/src/actions.ts
@@ -14,7 +14,7 @@ import { z } from 'zod';
 export const getTodos = rpcOperation()
   .outputs([
     {
-      body: z.array(todoSchema),
+      body: z.array(todoSchema).describe('List of TODOs.'),
       contentType: 'application/json'
     }
   ])
@@ -25,17 +25,19 @@ export const getTodos = rpcOperation()
 export const getTodoById = rpcOperation()
   .input({
     contentType: 'application/json',
-    body: z.string()
+    body: z.string().describe('TODO name.')
   })
   .outputs([
     {
-      body: z.object({
-        error: z.string()
-      }),
+      body: z
+        .object({
+          error: z.string()
+        })
+        .describe('TODO not found.'),
       contentType: 'application/json'
     },
     {
-      body: todoSchema,
+      body: todoSchema.describe('TODO response.'),
       contentType: 'application/json'
     }
   ])
@@ -52,9 +54,11 @@ export const getTodoById = rpcOperation()
 export const createTodo = rpcOperation()
   .input({
     contentType: 'application/json',
-    body: z.object({
-      name: z.string()
-    })
+    body: z
+      .object({
+        name: z.string()
+      })
+      .describe("New TODO's name.")
   })
   .outputs([{ body: todoSchema, contentType: 'application/json' }])
   .handler(async ({ name }) => {
@@ -68,8 +72,14 @@ export const deleteTodo = rpcOperation()
     body: z.string()
   })
   .outputs([
-    { body: z.object({ error: z.string() }), contentType: 'application/json' },
-    { body: z.object({ message: z.string() }), contentType: 'application/json' }
+    {
+      body: z.object({ error: z.string() }).describe('TODO not found.'),
+      contentType: 'application/json'
+    },
+    {
+      body: z.object({ message: z.string() }).describe('TODO deleted message.'),
+      contentType: 'application/json'
+    }
   ])
   .handler((id) => {
     const todo = MOCK_TODOS.find((t) => t.id === Number(id));
@@ -86,9 +96,14 @@ export const deleteTodo = rpcOperation()
 export const formDataUrlEncoded = rpcOperation()
   .input({
     contentType: 'application/x-www-form-urlencoded',
-    body: formSchema // A zod-form-data schema is required.
+    body: formSchema.describe('Test form description.') // A zod-form-data schema is required.
   })
-  .outputs([{ body: formSchema, contentType: 'application/json' }])
+  .outputs([
+    {
+      body: formSchema.describe('Test form response.'),
+      contentType: 'application/json'
+    }
+  ])
   .handler((formData) => {
     return {
       text: formData.get('text')
@@ -98,13 +113,28 @@ export const formDataUrlEncoded = rpcOperation()
 export const formDataMultipart = rpcOperation()
   .input({
     contentType: 'multipart/form-data',
-    body: multipartFormSchema // A zod-form-data schema is required.
+    body: multipartFormSchema, // A zod-form-data schema is required.
+    // The binary file cannot described with a Zod schema so we define it by hand for the OpenAPI spec.
+    bodySchema: {
+      description: 'Test form description.',
+      type: 'object',
+      properties: {
+        text: {
+          type: 'string'
+        },
+        file: {
+          type: 'string',
+          format: 'binary'
+        }
+      }
+    }
   })
   .outputs([
     {
       body: z.custom<File>(),
       // The binary file cannot described with a Zod schema so we define it by hand for the OpenAPI spec.
       bodySchema: {
+        description: 'File response.',
         type: 'string',
         format: 'binary'
       },

diff --git a/apps/example/src/app/api/v2/form-data/multipart/route.ts b/apps/example/src/app/api/v2/form-data/multipart/route.ts
@@ -13,6 +13,7 @@ export const { POST } = route({
       body: multipartFormSchema, // A zod-form-data schema is required.
       // The binary file cannot described with a Zod schema so we define it by hand for the OpenAPI spec.
       bodySchema: {
+        description: 'Test form description.',
         type: 'object',
         properties: {
           text: {
@@ -29,9 +30,10 @@ export const { POST } = route({
       {
         status: 200,
         contentType: 'application/octet-stream',
-        body: z.unknown(),
+        body: z.custom<File>(),
         // The binary file cannot described with a Zod schema so we define it by hand for the OpenAPI spec.
         bodySchema: {
+          description: 'File response.',
           type: 'string',
           format: 'binary'
         }

diff --git a/apps/example/src/app/api/v2/form-data/url-encoded/route.ts b/apps/example/src/app/api/v2/form-data/url-encoded/route.ts
@@ -9,13 +9,13 @@ export const { POST } = route({
   })
     .input({
       contentType: 'application/x-www-form-urlencoded',
-      body: formSchema // A zod-form-data schema is required.
+      body: formSchema.describe('Test form description.') // A zod-form-data schema is required.
     })
     .outputs([
       {
         status: 200,
         contentType: 'application/octet-stream',
-        body: formSchema
+        body: formSchema.describe('Test form response.') // A zod-form-data schema is required.
       }
     ])
     .handler(async (req) => {

diff --git a/...p/api/v2/route-with-query-params/route.ts → .../api/v2/route-with-params/[slug]/route.ts b/...p/api/v2/route-with-query-params/route.ts → .../api/v2/route-with-params/[slug]/route.ts
@@ -1,31 +1,37 @@
 import { TypedNextResponse, route, routeOperation } from 'next-rest-framework';
 import { z } from 'zod';
 
+const paramsSchema = z.object({
+  slug: z.enum(['foo', 'bar', 'baz'])
+});
+
 const querySchema = z.object({
   total: z.string()
 });
 
 export const runtime = 'edge';
 
 export const { GET } = route({
-  getQueryParams: routeOperation({
+  getPathParams: routeOperation({
     method: 'GET'
   })
     .input({
       contentType: 'application/json',
-      query: querySchema
+      params: paramsSchema.describe('Path parameters input.'),
+      query: querySchema.describe('Query parameters input.')
     })
     .outputs([
       {
         status: 200,
         contentType: 'application/json',
-        body: querySchema
+        body: paramsSchema.merge(querySchema).describe('Parameters response.')
       }
     ])
-    .handler((req) => {
+    .handler((req, { params: { slug } }) => {
       const query = req.nextUrl.searchParams;
 
       return TypedNextResponse.json({
+        slug,
         total: query.get('total') ?? ''
       });
     })

diff --git a/apps/example/src/app/api/v2/route-with-path-params/[slug]/route.ts b/apps/example/src/app/api/v2/route-with-path-params/[slug]/route.ts
diff --git a/apps/example/src/app/api/v2/todos/[id]/route.ts b/apps/example/src/app/api/v2/todos/[id]/route.ts
@@ -4,18 +4,27 @@ import { z } from 'zod';
 
 export const runtime = 'edge';
 
+const paramsSchema = z
+  .object({
+    id: z.string()
+  })
+  .describe('TODO ID path parameter.');
+
 export const { GET, DELETE } = route({
   getTodoById: routeOperation({
     method: 'GET'
   })
+    .input({
+      params: paramsSchema
+    })
     .outputs([
       {
-        body: todoSchema,
+        body: todoSchema.describe('TODO response.'),
         status: 200,
         contentType: 'application/json'
       },
       {
-        body: z.string(),
+        body: z.string().describe('TODO not found.'),
         status: 404,
         contentType: 'application/json'
       }
@@ -37,14 +46,17 @@ export const { GET, DELETE } = route({
   deleteTodo: routeOperation({
     method: 'DELETE'
   })
+    .input({
+      params: paramsSchema
+    })
     .outputs([
       {
-        body: z.string(),
+        body: z.string().describe('TODO deleted.'),
         status: 204,
         contentType: 'application/json'
       },
       {
-        body: z.string(),
+        body: z.string().describe('TODO not found.'),
         status: 404,
         contentType: 'application/json'
       }

diff --git a/apps/example/src/app/api/v2/todos/route.ts b/apps/example/src/app/api/v2/todos/route.ts
@@ -12,7 +12,7 @@ export const { GET, POST } = route({
       {
         status: 200,
         contentType: 'application/json',
-        body: z.array(todoSchema)
+        body: z.array(todoSchema).describe('List of TODOs.')
       }
     ])
     .handler(() => {
@@ -26,26 +26,28 @@ export const { GET, POST } = route({
   })
     .input({
       contentType: 'application/json',
-      body: z.object({
-        name: z.string()
-      })
+      body: z
+        .object({
+          name: z.string()
+        })
+        .describe("New TODO's name.")
     })
     .outputs([
       {
         status: 201,
         contentType: 'application/json',
-        body: z.string()
+        body: z.string().describe('New TODO created message.')
       },
       {
         status: 401,
         contentType: 'application/json',
-        body: z.string()
+        body: z.string().describe('Unauthorized.')
       }
     ])
     // Optional middleware logic executed before request validation.
     .middleware((req) => {
       if (!req.headers.get('very-secure')) {
-        return TypedNextResponse.json('Unauthorized', {
+        return TypedNextResponse.json('Unauthorized.', {
           status: 401
         });
       }

diff --git a/apps/example/src/pages/api/v1/form-data/multipart/index.ts b/apps/example/src/pages/api/v1/form-data/multipart/index.ts
@@ -18,6 +18,7 @@ export default apiRoute({
       body: multipartFormSchema, // A zod-form-data schema is required.
       // The binary file cannot described with a Zod schema so we define it by hand for the OpenAPI spec.
       bodySchema: {
+        description: 'Test form description.',
         type: 'object',
         properties: {
           text: {
@@ -34,9 +35,10 @@ export default apiRoute({
       {
         status: 200,
         contentType: 'application/octet-stream',
-        body: z.unknown(),
+        body: z.custom<File>(),
         // The binary file cannot described with a Zod schema so we define it by hand for the OpenAPI spec.
         bodySchema: {
+          description: 'File response.',
           type: 'string',
           format: 'binary'
         }

diff --git a/apps/example/src/pages/api/v1/form-data/url-encoded/index.ts b/apps/example/src/pages/api/v1/form-data/url-encoded/index.ts
@@ -7,13 +7,13 @@ export default apiRoute({
   })
     .input({
       contentType: 'application/x-www-form-urlencoded',
-      body: formSchema // A zod-form-data schema is required.
+      body: formSchema.describe('Test form description.') // A zod-form-data schema is required.
     })
     .outputs([
       {
         status: 200,
         contentType: 'application/json',
-        body: formSchema
+        body: formSchema.describe('Test form response.')
       }
     ])
     .handler((req, res) => {

diff --git a/...v1/route-with-path-params/[slug]/index.ts → .../api/v1/route-with-params/[slug]/index.ts b/...v1/route-with-path-params/[slug]/index.ts → .../api/v1/route-with-params/[slug]/index.ts
@@ -5,19 +5,24 @@ const paramsSchema = z.object({
   slug: z.enum(['foo', 'bar', 'baz'])
 });
 
+const querySchema = z.object({
+  total: z.string()
+});
+
 export default apiRoute({
-  getQueryParams: apiRouteOperation({
+  getParams: apiRouteOperation({
     method: 'GET'
   })
     .input({
       contentType: 'application/json',
-      query: paramsSchema
+      params: paramsSchema.describe('Path parameters input.'),
+      query: querySchema.describe('Query parameters input.')
     })
     .outputs([
       {
         status: 200,
         contentType: 'application/json',
-        body: paramsSchema
+        body: paramsSchema.merge(querySchema).describe('Parameters response.')
       }
     ])
     .handler((req, res) => {