REST Web Services

Introduction

Representational State Transfer (REST) is an architectural style that specifies constraints, such as the uniform interface, that if applied to a web service induce desirable properties, such as performance, scalability, and modifiability, that enable services to work best on the Web.

About REST

Netuno services are built on REST API

ALL

To build a Netuno service that answers to any type of HTTP method:

  • 📂 server/services/my-service.js

In the browser, this service will be performed for all types of requests at the address:

GET

For listing or data retrieval operations, GET-type addresses are normally used.

To create a service on Netuno that only respondes to the GET method type, use one of the following:

  • 📂 server/services/list/get.js
  • 📂 server/services/list.get.js

Into your browser this service will be only executed for the GET request type at the address.

POST

POST addresses are normally used for operations that store data.

To create a service on Netuno that only responds to the POST method type, create the code file using one of the following options:

  • 📂 server/services/save/post.js
  • 📂 server/services/save.post.js

This service will be performed only for the POST request type at the address below:

PUT

PUT addresses are normally used for operations that create new data records.

To create a service on Netuno that only responds to the PUT method type, create the code file using one of the below options:

  • 📂 server/services/build/put.js
  • 📂 server/services/build.put.js

This service will be only performed for the PUT order type at the below address:

DELETE

DELETE addresses are normally used for operations that will delete new data records.

To create a service on Netuno that will only answer to the DELETE method type, create the code file using one of the following options:

  • 📂 server/services/remove/delete.js
  • 📂 server/services/remove.delete.js

This service will be only executed for the DELETE order type at the address below:

OPTIONS

Integrating with the frontend, during the CORS validation process, the browser makes an OPTIONS call.

MORE About CORS.

To create a service on Netuno that will only answer to the OPTIONS method type, create the file code using one of the following options:

  • 📂 server/services/list/options.js
  • 📂 server/services/list.options.js

It should be implemented for all services that are integrated in an external frontend, such as a website.

See below the code line used:

_out.json(_val.map().set("result", true))

This service will be executed for the order type OPTIONS at the address:

Test Execution

To run tests on services with the specific type of method, you can use your own programs that perform tests on the REST API, see below example:

CURL

The following curl command on the terminal the user will be able to execute type of test.

From the console / command line sends a GET:

curl http://localhost:9000/services/save

With -X can be specified the type of method:

curl -X POST -F 'nome=Test' -F 'email=email@example.com' http://localhost:9000/services/save

The pamameter-F sends with the Content-Type: multipart/form-data

Another way to send parameters:

curl -X POST -d 'name=Test' -d 'email=email@example.com' http://localhost:9000/services/save

It can be concatenated as:

curl -X POST -d 'name=Test&email=email@example.com' http://localhost:9000/services/save

The parameter -d sends with Content-Type: application/x-www-form-urlencoded

JSON

To send in JSON format, it is necessary to specify the content type:

curl -X POST -H "Content-Type: application/json" \
    -d '{"nome": "Test", "email": "email@example.com"}' \
    http://localhost:9000/services/save

To define the parameterization of the header (HEADER) use -H

Upload

To upload files:

curl -X POST -F 'image=@/home/user/file.jpg' http://localhost:9000/services/save

Service Client - NPM

The NPM module is available, to easily integrate with the frontend:

Instalation command: npm i -S @netuno/service-client

Define the services address 👇 👇

_service.config({
    prefix: 'http://localhost:9000/services/'
});

You can run services integrated with the frontend:

  _service({
      url: "/services/my-service",
      method: 'POST',
      data: { param1: "1", param2: "2" },
      success: (response) => {
          if (response.json) {
              console.log("Service Response", response.json);
          }
      },
      fail: (e) => {
          console.log("Service Error", e);
      }
  });

Summarize

Only to the type of HTTP method desired, it is supported to restrict services.

To integrate with the frontend it can be done at the lowest level using fetch.

To streamline and standardize the implementation, the NPM module [@ netuno / service-client] (https://www.npmjs.com/package/@netuno/service-client) is available.

← DB Connection PoolWebSocket →