3rd: API Design

[misostack]

Includes:

• Controller and Methods for CRUD
• Input validation: DTOs, Pipes
• Unify response: input validation errors, crud responses, processing error, server error - Interceptors
• API Doc with Swagger
• Transform Output: class transformer and response DTOs
• Pagination : limit, offset
• Search: filter
• Authorization: Middleware, Auth Guard, Role base Access Control
• Unit Tests: Mock, Spy & Stubs
• Upload file: multipart form data
• Multi media endpoints: display image, download file, html, streaming
• Cache: header cache keys, redis cache, cache invalidation

[misostack]

Controllers and methods for resource

Naming Controller: ExamplesController

Method	Endpoint	Params	Method	Description	Success Status	Response
GET	/examples	Query Param : ?filter={}&pageNumber=1&pageSize=10	index	List examples	Success: 200	Example[]
POST	/examples	Body : JSON data ExampleDTO	create	Create new example	Success: 201	Example or exampleId
GET	/examples/{id}	Route Param: id	show	Get details of an example	Success: 200	Example
PATCH	/examples/{id}	Route Param: id Body : JSON data ExampleUpdateDTO	update	Update an example partially	Success: 200	exampleId
DELETE	/examples/{id}	Route Param : id	remove	Delete an example	Success: 204	No content

@Controller('examples')
export class ExamplesController {
  constructor(private exampleService: ExampleService) {}
  // index, show, create, update, destroy
  @Get()
  index() {
    return [];
  }

  @Get(':id')
  show() {
    return {};
  }

  @Post('')
  create(@Body() payload): Example {
    const example: Example = this.exampleService.create(payload);
    return example;
  }

  @Patch(':id')
  update() {
    return {};
  }

  @Delete(':id')
  destroy() {
    return {};
  }
}

[misostack]

Validate Request Input in NestJS

• Validate Request Input in NestJS the right way