feat: add put verb (#41)

Co-authored-by: Maxime Larichelliere <Galabar64@users.noreply.github.com>
Jnig · May 22, 2023 · 771da89 · 771da89
1 parent 31bd754
commit 771da89
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -86,7 +86,7 @@ The following code snippets are only provided as example. It's best to start a n
 `Todo.controller.ts`
 
 ```ts
-import { Controller, Delete, Get, Post, Status } from '@fluxapi/common';
+import { Controller, Delete, Get, Post, Put, Status } from '@fluxapi/common';
 import {
   CreateTodo,
   ListTodoQuery,
@@ -111,7 +111,7 @@ export class TodoController {
     // implementation
   }
 
-  @Post('/:id')
+  @Put('/:id')
   async update(id: number, body: UpdateTodo): Promise<TodoResponse> {
     // implementation
   }

diff --git a/packages/common/src/decorator.ts b/packages/common/src/decorator.ts
@@ -56,6 +56,13 @@ export function Post(url: string = ''): MethodDecorator {
   };
 }
 
+export function Put(url: string = ''): MethodDecorator {
+  return function (target: Object, functionName: string | symbol) {
+    addProperty(target, functionName, 'url', url);
+    addProperty(target, functionName, 'method', 'PUT');
+  };
+}
+
 export function Status(code: number): MethodDecorator {
   return function (target: Object, functionName: string | symbol) {
     addProperty(target, functionName, 'statusCode', code);

diff --git a/playground/integration-tests/src/crud/crud.controller.ts b/playground/integration-tests/src/crud/crud.controller.ts
@@ -1,4 +1,4 @@
-import { Controller, Delete, Get, Post, Status } from 'fastify-flux';
+import { Controller, Delete, Get, Post, Put, Status } from 'fastify-flux';
 import { CreateTodo, ListTodoQuery, TodoResponse, UpdateTodo } from './crud.schema';
 import { HttpException } from '~/helper/exceptions';
 
@@ -32,7 +32,7 @@ export class CrudController {
     return found;
   }
 
-  @Post('/:id')
+  @Put('/:id')
   async update(id: number, body: UpdateTodo): Promise<TodoResponse> {
     const found = todos.find((x) => x.id === id);
 

diff --git a/playground/integration-tests/tests-e2e/__snapshots__/swagger.test.ts.snap b/playground/integration-tests/tests-e2e/__snapshots__/swagger.test.ts.snap
@@ -1164,7 +1164,7 @@ exports[`schema 1`] = `
           "todos",
         ],
       },
-      "post": {
+      "put": {
         "operationId": "update",
         "parameters": [
           {

diff --git a/playground/template-prisma/src/controllers/Todo.controller.ts b/playground/template-prisma/src/controllers/Todo.controller.ts
@@ -1,4 +1,4 @@
-import { Controller, Delete, Get, Post, Status } from 'fastify-flux';
+import { Controller, Delete, Get, Post, Put, Status } from 'fastify-flux';
 import { CreateTodo, ListTodoQuery, TodoResponse, UpdateTodo } from './Todo.schema';
 import { HttpException } from '~/helper/exceptions';
 import { PrismaClient } from '@prisma/client';
@@ -32,7 +32,7 @@ export class TodoController {
     return found;
   }
 
-  @Post('/:id')
+  @Put('/:id')
   async update(id: number, body: UpdateTodo): Promise<TodoResponse> {
     const found = await prisma.todos.findUnique({ where: { id } });
 

diff --git a/playground/template-prisma/tests-e2e/api/GeneratedApi.ts b/playground/template-prisma/tests-e2e/api/GeneratedApi.ts
@@ -86,21 +86,13 @@ export class HttpClient<SecurityDataType = unknown> {
     const requestParams = params;
     const responseFormat = (format && this.format) || void 0;
 
-    if (!type) {
-      type = ContentType.Json;
-    }
-
     if (!body) {
       body = {};
     }
 
     try {
       const result: any = await this.instance.request({
         ...requestParams,
-        headers: {
-          ...(type && type !== ContentType.FormData ? { 'Content-Type': type } : {}),
-          ...(requestParams.headers || {}),
-        } as any,
         params: query,
         responseType: responseFormat,
         data: body,
@@ -220,7 +212,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      *
      * @tags todos
      * @name Update
-     * @request POST:/todos/{id}
+     * @request PUT:/todos/{id}
      */
     update: (
       id: number,
@@ -245,7 +237,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         any
       >({
         path: `/todos/${id}`,
-        method: 'POST',
+        method: 'PUT',
         body: data,
         type: ContentType.Json,
         format: 'json',

diff --git a/playground/template-prisma/tests-e2e/todo.test.ts b/playground/template-prisma/tests-e2e/todo.test.ts
@@ -8,6 +8,12 @@ test('create todo', async () => {
   await client.todos.create({ text: 'foobar', priority: 1 });
 });
 
+test('update todo', async () => {
+  const result = await client.todos.create({ text: 'foobar', priority: 1 });
+  await client.todos.get(result.id);
+  await client.todos.update(result.id, { text: 'barfoo', priority: 2 });
+});
+
 test('get todo', async () => {
   const result = await client.todos.create({ text: 'foobar', priority: 1 });
   await client.todos.get(result.id);