Posts

Showing posts with the label swagger

NestJS Controller and Swagger Guide

Image
Introduction NestJS is a progressive Node.js framework built with TypeScript, facilitating the development of efficient and scalable server-side applications. By default, NestJS uses Express as its core HTTP processing library. Key advantages include a tight modular architecture inspired by Angular and strong TypeScript support to reduce code errors. Controllers serve as the layer for processing incoming requests and returning responses to the client side. Their primary responsibility is to receive HTTP requests, route data to business logic services, and coordinate the returned result in the correct format. Swagger is a powerful suite of tools used for designing, building, and documenting RESTful APIs developed based on the OpenAPI data format specification. In NestJS, it helps automatically generate an intuitive UI interface for testing endpoints, enabling developers and stakeholders to understand the API structure without directly reading the source code. Detail After creating the N...

Creating API Documentation with Swagger on NodeJS

Image
Introduction Swagger is a popular, simple, and user-friendly tool for creating APIs . Most backend developers, regardless of the programming languages they use, are familiar with Swagger . This article will guide you through creating API documentation using Swagger on Node.js (specifically integrated with the Express framework). This is handy when you want to provide API documentation in a professional UI format for stakeholders involved in integration. Restful API REST stands for Representational State Transfer . It is an architectural style that defines a set of constraints for creating web services. RESTful APIs provide a simple and flexible way to access web services without complex processing. Common HTTP Methods in RESTful APIs : - GET : Used to read (retrieve) a representation of a resource. It returns data in XML or JSON format. - POST : Creates new resources or subordinates to existing ones. - PUT : Updates existing resources or creates new ones if the client chooses the...