Breaking News: Grepper is joining You.com. Read the official announcement!

Do you follow any standards to build a rest service?

Add Answer

Pragya Keshap answered on February 21, 2023 Popularity 1/10 Helpfulness 1/10

answer Do you follow any standards to build a rest service?

Do you follow any standards to build a rest service?

Comment

There are several standards that you should follow when building a RESTful service:

Use HTTP methods (e.g. GET, POST, PUT, DELETE) appropriately:

GET should be used to retrieve data.

POST should be used to create new data.

PUT should be used to update existing data.

DELETE should be used to delete data.

Use HTTP status codes correctly:

2xx status codes (e.g. 200, 201) should be used to indicate success.

4xx status codes (e.g. 400, 401) should be used to indicate an error that occurred due to the client.

5xx status codes (e.g. 500, 501) should be used to indicate an error that occurred on the server.

2. Use a consistent and logical URL structure.

Use appropriate HTTP headers (e.g. Content-Type, Authorization).

Allow for flexible content negotiation (e.g. support different formats such as JSON and XML).

Follow the principles of REST (e.g. use hypermedia, cache resources, and design for visibility and reliability).

It’s also a good idea to design your RESTful service in a way that is easy for developers to use and understand and follows common conventions for building APIs.

const express = require('express');
const bodyParser = require('body-parser');

const app = express();

app.use(bodyParser.json());

app.get('/articles', (req, res) => {
  const articles = [];
  // code to retrieve an article...
  res.json(articles);
});

app.post('/articles', (req, res) => {
  // code to add a new article...
  res.json(req.body);
});

app.put('/articles/:id', (req, res) => {
  const { id } = req.params;
  // code to update an article...
  res.json(req.body);
});

app.delete('/articles/:id', (req, res) => {
  const { id } = req.params;
  // code to delete an article...
  res.json({ deleted: id });
});

app.listen(3000, () => console.log('server started'));

https://stackoverflow.blog/2020/03/02/best-practices-for-rest-api-design/

Popularity 1/10 Helpfulness 1/10 Language javascript

Source: Grepper

Tags: any build javascript rest standards

Link to this answer
Share Copy Link

Contributed on Feb 21 2023

Pragya Keshap

0 Answers Avg Quality 2/10

Do you follow any standards to build a rest service?

Contents

More Related Answers

Do you follow any standards to build a rest service?

Grepper

Documentation

Social

Legal

Contact

Oops, You will need to install Grepper and log-in to perform this action.