Forem: Paweł Partyka

Query parameters in node.js

Paweł Partyka — Sat, 25 Nov 2023 12:30:48 +0000

Today we will use Cavia to parse the request query parameters.

Step 1: Installation

First, let's install the @caviajs/http-query package.

npm install @caviajs/http-query --save

Step 2: Usage

Now, use the HttpQuery in route handler to parse query parameters.

import { Route } from '@caviajs/http-router';
import { HttpQuery } from '@caviajs/http-query'; // 👈

export const GuineaPigListRoute: Route = {
  handler: async (request, response): Promise<void> => {
    const query = HttpQuery.parse(request); // 👈

    console.log(query); // 👈 do sth with query parameters...
  },
  method: 'GET',
  path: '/guinea-pigs/list',
};

Remember to add the newly created route to the HttpRouter instance and start the server.

Step 3: Make request

Make a request to newly created endpoint.

curl -XGET 'http://localhost:8080/guinea-pigs/list?name=foo'

Yes, it's that simple.
See you!

Path parameters in node.js

Paweł Partyka — Fri, 24 Nov 2023 19:38:21 +0000

Today we will create a route with path parameters. Fortunately, Cavia's parameter parsing mechanism is built-in and using it is very simple.

Step 1: New endpoint

Create a new endpoint with path params - to indicate the position of a parameter in the path, add a colon in front of the parameter name.

import { Route } from '@caviajs/http-router';

export const GuineaPigDetailsRoute: Route = {
  handler: async (request, response): Promise<void> => {
    const id = request.params.id; // 👈

    console.log(id); // 👈 do sth...
  },
  method: 'GET',
  path: '/guinea-pigs/details/:id', // 👈
};

Remember to add the newly created route to the HttpRouter instance and start the server.

Step 2: Make request

Make a request to newly created endpoint.

curl -XGET 'http://localhost:8080/guinea-pigs/details/1245'

Yes, it's that simple.
See you!

Parse request body with node.js

Paweł Partyka — Fri, 24 Nov 2023 18:07:26 +0000

In the last post we used the Cavia to create the first endpoint, today we will use this micro framework to parse the request body.

Step 1: Installation

First, let's install the @caviajs/http-body package, which enables parsing.

npm install @caviajs/http-body --save

Step 2: New endpoint

Create a new endpoint whose method is POST, PUT or PATCH.

import { Route } from '@caviajs/http-router';
import { HttpBody } from '@caviajs/http-body'; // 👈

export const GuineaPigCreateRoute: Route = {
  handler: async (request, response): Promise<void> => {
    const body = await HttpBody.parse(request, 'json'); // 👈

    console.log(body);
  },
  method: 'POST', // 👈
  path: '/guinea-pigs',
};

The created endpoint add to HttpRouter instance.

import http from 'http';
import { HttpRouter } from '@caviajs/http-router';
import { GuineaPigCreateRoute } from './routes/guinea-pig-create-route'; // 👈

(async () => {
  const httpRouter: HttpRouter = new HttpRouter();

  httpRouter
    .route(GuineaPigCreateRoute); // 👈

  const httpServer: http.Server = http.createServer((req, res) => {
    httpRouter.handle(req, res);
  });

  httpServer.listen(8080, () => {
    console.log(`Http server listening at port ${8080}`);
  });
})();

Step 3: Start server

Start the server using the terminal.

npx ts-node app/web.ts

Step 4: Make request

Make a request to our newly created endpoint.

curl -XPOST -H "Content-type: application/json" -d '{"name":"Hello World"}' 'http://localhost:8080/guinea-pigs'

It's all for today! I hope this short post was helpful to you.
See you!

Create a simple http server with node.js

Paweł Partyka — Thu, 23 Nov 2023 19:25:48 +0000

Welcome to my new blog! Today we will start the adventure of exploring the world of web applications using Node.js. We'll start with something simple - create your own HTTP endpoint using Cavia Framework.

Why Cavia?

Cavia is a lightweight library for handling HTTP requests in Node.js. Its simplicity makes it perfect for those who want to quickly start creating simple web applications.

Step 1: Installation

The first step is to install the packages for your project using the command below.

npm install @caviajs/http-router @caviajs/http-exception rxjs --save

You can also use a template available at typescript-starter.

Step 2: Endpoint

Now let's create our entry point. Let's enter the following code in the app/web.ts file:

import http from 'http';
import { HttpRouter } from '@caviajs/http-router';

(async () => {
  const httpRouter: HttpRouter = new HttpRouter();

  httpRouter
    .route({
      handler: async (request, response): Promise<string> => {
        return 'Hello world!';
      },
      method: 'GET',
      path: '/hello',
    });

  const httpServer: http.Server = http.createServer((req, res) => {
    httpRouter.handle(req, res);
  });

  httpServer.listen(8080, () => {
    console.log(`Http server listening at port ${8080}`);
  });
})();

Step 3: Starting the server

When our entry point is ready, we can now start the server.

npx ts-node app/web.ts

Running the app/web.ts file will start the server and we will be able to test our endpoint by entering the address in the browser http://localhost:8080/hello.

It's all for today! I hope this short post was helpful to you. In the next articles we will develop our web application. See you!