😀Added: Readme docs

coderj001 · Oct 10, 2023 · 3c279c3 · 3c279c3
1 parent 47f46b8
commit 3c279c3
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -25,6 +25,7 @@ pnpm start:prod
 
 ## Paths
 
-|  Path   |   Source   | Method |    Response    | Queries |
-| :-----: | :--------: | :----: | :------------: | :-----: |
-| /api/v1 | characters |  GET   | All characters |  soon   |
+|  Path   |     Source     | Method |       Response       | Queries |
+| :-----: | :------------: | :----: | :------------------: | :-----: |
+| /api/v1 |   characters   |  GET   |    All characters    |  soon   |
+| /api/v1 | characters/:id |  GET   | Only character by id |   --    |
diff --git a/rest.http b/rest.http
@@ -5,6 +5,12 @@ GET {{baseURL}}/health
 Content-Type: application/json
 
 ### Characters
-### FindAll
-GET  {{baseURL}}/api/v1/characters
-Content-Type: application/json
+### Find All
+GET  {{baseURL}}/api/v1/characters?limit=10
+Content-Type: application/json
+
+### Find By Name
+GET  {{baseURL}}/api/v1/characters?name=gojo
+
+### Find By Id
+GET  {{baseURL}}/api/v1/characters/2
diff --git a/src/characters/characters.controller.ts b/src/characters/characters.controller.ts
@@ -4,11 +4,9 @@ import { CharactersService, IQuery } from "./characters.service";
 import { serializeStringToNumeric } from "../helper/serialize-string-numeric";
 
 export class CharactersController {
-  constructor(private readonly charactersService: CharactersService) {}
+  constructor(private readonly charactersService: CharactersService) { }
 
-  // async findAll({ limit, name, offset, sort }: IQuerystring = {}) {
   async findAll({ limit, offset, name }: IQuerystring = {}) {
-    // const isSorted = sort != undefined && sort != null && Boolean(sort);
     if (name) {
       return await this.charactersService.findByName(name);
     }