Is it possible to 'get' data using POST with json-server? #453

vsharma2266 · 2017-01-11T15:19:07Z

Hi,

I am trying to get response using POST. My POST body has some key-value pairs which determine what needs to be responded.
Is it possible to get data back from POST method ?

Thanks

sanserna · 2017-03-02T21:55:15Z

It would be helpful if they answered this issue... i'am facing the same problem

typicode · 2017-03-02T22:51:05Z

Hi @vsharma2266 @sanserna,

Out of the box it's not possible, sorry. With REST, making a POST usually mean that you request a change and if you want to query GET is the right verb.

That said, using the project as a module, you can fake it:

// server.js
var jsonServer = require('json-server')
var server = jsonServer.create()
var router = jsonServer.router('db.json')
var middlewares = jsonServer.defaults()

server.use(middlewares)

server.use(jsonServer.bodyParser)
server.use(function (req, res, next) {
  if (req.method === 'POST') {
    // Converts POST to GET and move payload to query params
    // This way it will make JSON Server that it's GET request
    req.method = 'GET'
    req.query = req.body
  }
  // Continue to JSON Server router
  next()
})

// If you need to scope this behaviour to a particular route, use this
server.post('/comments', function (req, res, next) {
  req.method = 'GET'
  req.query = req.body
  next()
})

server.use(router)
server.listen(3000, function () {
  console.log('JSON Server is running')
})

I would suggest checking https://expressjs.com/ docs and https://github.com/typicode/json-server#module

And if you need to customize more, you can also access router's lowdb instance using router.db.

Hope this helps :)

hopkinson · 2017-04-20T09:17:14Z

@typicode i tried pasted above code ,but i found that i failed to get data
in routes.json,
'/api/product/stocks_index/list': '/referenceList/:id'
I want '/api/product/stocks_index/list' this api‘s request value is {id:1},and want to turn '/referenceList/:id' into '/referenceList/1' but ,/api/product/stocks_index/list can not change such as/api/product/stocks_index/list?id=1` ..
Or,what can i solve this problem?

vsharma2266 · 2017-08-14T13:52:50Z

Closing as this question is answered.

appsparkler · 2017-11-09T05:08:16Z

This is what worked for me:

Instead of writing the server.js file from scratch and executing it; I created a middleware file. The contents of the middleware file are from @typicode's response above:

// middleware-1.js
module.exports = function (req, res, next) {
  if (req.method === 'POST') {
    // Converts POST to GET and move payload to query params
    // This way it will make JSON Server that it's GET request
    req.method = 'GET'
    req.query = req.body
  }
  // Continue to JSON Server router
  next()
}

Next, this is in my json-server.json file:

{
    //...
    "middlewares": ["middleware-1.js"],
    //..
}

The db.json file is as usual with all the data, and finally, executed the code:

json-server db.json

Good Luck.

mircolac · 2017-12-01T14:46:28Z

@appsparkler thanks a lot for your answer, it helped me fixing a problem in the project i'm working at the moment.

Moreover, while writing the middleware and testing your solution, I discovered a weird behaviour when the query result cointained a field with the same name of a field contained in the POST original body.

I'll explain it better, using an example from the code I wrote

HTTP request

(variable's names are voluntarily changed)

this.http.post<OutputFormat>(EndpointUrl('URL'),
      {
        'foo': foo,
        'bar': bar,
        'baz': 'baz',
        'qux': 'qux'
    })
      .subscribe(
      res => {
        console.log("res is  ",res);
       ...

MIDDLEWARE

module.exports = (req, res, next) => {
...
                req.method ='GET';
                req.query = req.body
                next();
...
}

RESULT:
Everything works fine UNLESS the json at the endpoint contains a field that has the same label of the fields in the req.body ( 'foo', 'bar', 'baz' or 'qux' ).

example:

"endpointYouAskedFor": [
    {
      "foo": {...},
      "someOtherThing": {...}
}

In this case, the result will be an empty res object.
If there was no 'foo' field in the endpoint, everything would have been fine.

I hope this will be useful and spare some hours to someone :)

appsparkler · 2017-12-02T06:08:56Z

hi @mircolac

i'm not sure if this would work but another thing that we can include in the middleware is to make the req.body into an empty object before :

// ...
    req.query = req.body;
    delete req.body; //or null (if that works)
// ...

this might avoid the req.body reaching the json-server logic without missing out on the query...

mircolac · 2017-12-04T09:03:44Z

Hey @appsparkler
That was certainly worth a try, but unfortunately didn't fix the problem!

Thanks anyway :)

leohxj · 2018-02-01T05:59:51Z

@typicode
I use POST method to make some change, but want to get some response (not the insert resource).

Is there another way which not to make the method to 'get' ?

Thanks.

leotm · 2018-02-02T00:14:49Z

@leohxj Is there an issue with setting your method to get, like so?

server.post('/some/url', (req, res) => {
  req.method = 'GET'
  res.jsonp({ some: "response" })
})

As you can still POST to your server, .then use the response.

m-e-conroy · 2018-02-09T21:44:12Z

I needed to reroute the URL but resetting req.url wasn't working so I did the following.

const jsonServer = require('json-server');
const server = jsonServer.create();
const router = jsonServer.router('db.json');
const request = require('request');
const middlewares = jsonServer.defaults();

server.use(middlewares);
server.use(jsonServer.bodyParser);

server.post('/login',(req,res,next) => {
  // We don't care if we don't check the password we just want to receive a user back for testing
  let url = 'http://localhost:3000/user?login.username=' + req.body.username;
  request({url: url, json: true},(err, response, body) => {
    res.send(body);
  });
}); // post(/login)

server.use(router);

server.listen(3000, ()=>{
  console.log('http://localhost:3000 Running...');
});

MickL · 2019-02-13T14:57:26Z

It seems like the only way is write a middleware that changes requests from POST to GET:

server.use((req, res, next) => {
  if (req.method === 'POST') {
    req.method = 'GET';
  }
  next();
});

You can still have and react to POST requests if you do this BEFORE the middleware:

server.post('/addUser', (req, next) => {
  res.jsonp(myResponse);
});

server.use((req, res, next) => {
  if (req.method === 'POST') {
    req.method = 'GET';
  }
  next();
});

SetTrend · 2019-03-29T18:30:39Z

I've been facing the same issue. My team demands sending their query data in the body, so they're using a POST instead of a GET for querying data.

After searching the web I created a json-server.js file that sends a GET when it's supposed to send a POST (I currently don't filter which addresses to convert).

So, for anyone who's searching for a compound json-server.js file, here's mine:

// json-server.js
const jsonServer = require('json-server');
const bodyParser = require("body-parser");
const server = jsonServer.create();
const router = jsonServer.router('./db.json');
const middlewares = jsonServer.defaults();

server.use(bodyParser.json());
server.use(bodyParser.urlencoded({
	extended: true
}));

server.use(function (req, res, next) {
	if (req.method === 'POST') {

		// Converts POST to GET and move payload to query params
		req.method = 'GET';
		req.query = {}

		for (let p in req.body) req.query[p] = req.body[p];
	}
	// Continue to JSON Server router
	next();
});

server.use(middlewares)
server.use(router)

const port = 3000;
server.listen(port, () => console.log(`JSON Server is running on port ${port} ...`))

beanmac · 2019-04-05T21:14:28Z

Thanks for the details @SetTrend.

gazdagergo · 2019-05-10T11:09:01Z

I set up a middleware like this and works fine for me:

middleware1.js

module.exports = function (req, res, next) {
  if (req.method === 'POST' && req.originalUrl === '/user/login') {
    return res.jsonp({ token: "foo" })
  }
  next()
}

And run

> json-server  --middlewares middleware1.js  ...

isahilpahuja · 2019-05-22T13:49:08Z

@appsparkler thanks a lot for your answer, it helped me fixing a problem in the project i'm working at the moment.

Moreover, while writing the middleware and testing your solution, I discovered a weird behaviour when the query result cointained a field with the same name of a field contained in the POST original body.

I'll explain it better, using an example from the code I wrote

HTTP request

(variable's names are voluntarily changed)
this.http.post<OutputFormat>(EndpointUrl('URL'),
      {
        'foo': foo,
        'bar': bar,
        'baz': 'baz',
        'qux': 'qux'
    })
      .subscribe(
      res => {
        console.log("res is  ",res);
       ...
MIDDLEWARE
module.exports = (req, res, next) => {
...
                req.method ='GET';
                req.query = req.body
                next();
...
}
RESULT:
Everything works fine UNLESS the json at the endpoint contains a field that has the same label of the fields in the req.body ( 'foo', 'bar', 'baz' or 'qux' ).

example:
"endpointYouAskedFor": [
    {
      "foo": {...},
      "someOtherThing": {...}
}
In this case, the result will be an empty res object.
If there was no 'foo' field in the endpoint, everything would have been fine.

I hope this will be useful and spare some hours to someone :)

Thanks for this!!

webia1 · 2020-06-13T13:26:36Z

maybe, it is much easier and you don't have to change methods:

const server = jsonServer.create();
const router = jsonServer.router(db);
const middlewares = jsonServer.defaults();
const port = 3000;

// @ts-ignore
router.render = (req, res) => {
  if (req.originalUrl === '/whatever' && req.originalMethod === 'POST') {
    res.jsonp({
      result: {
        agent: 'James Bond',
        code: '007',
      },
    });
  } else {
    res.jsonp({
      result: res.locals.data,
    });
  }
};

server.use(middlewares);
server.use(router);

server.listen(port, () => {
  console.log(`JSON Server is running on port ${port}`);
});

alexcroox · 2022-04-27T11:38:31Z

Note req.query = req.body will result in a 500 error due to there being a json-server specific _delay property on req.query.

This prevents that:

req.query = { ...req.query, ...req.body }

Jackie098 · 2023-03-31T15:33:19Z

@appsparkler in this case, if i add "middlewares": ["middleware-1.js"], inside a json-server.json, he will understand that is a new route.

Is there no other way to do this work within only "json files" without needing a server.js file?

appsparkler · 2023-04-07T02:48:19Z

Hi @Jackie098, this was a long time ago (5-6 yrs). I've not been using json-server for few years now
and am no longer sure about its implementation, logic, etc. I'm currently focused on Android
with Compose in Kotlin so I hope you understand.

Thanks & Regards

Jackie098 · 2023-04-07T03:27:21Z

@appsparkler i understand! Thanks for answered me 😁❤️

vsharma2266 closed this as completed Aug 14, 2017

samechikson mentioned this issue Sep 7, 2017

Is there a way to accept POST, PUT etc but not override json content, and also respond with said content? #581

Closed

chiptus mentioned this issue Nov 27, 2017

Use custom reply for POST #574

Closed

barnabasbartha mentioned this issue Mar 11, 2021

Disable saving on POST #1227

Closed

calinafox mentioned this issue Apr 20, 2021

When doing a POST can I do in any way not to perform an update and to act as a GET? #1235

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Is it possible to 'get' data using POST with json-server? #453

Is it possible to 'get' data using POST with json-server? #453

vsharma2266 commented Jan 11, 2017

sanserna commented Mar 2, 2017

typicode commented Mar 2, 2017

hopkinson commented Apr 20, 2017 •

edited

Loading

vsharma2266 commented Aug 14, 2017

appsparkler commented Nov 9, 2017 •

edited

Loading

mircolac commented Dec 1, 2017 •

edited

Loading

appsparkler commented Dec 2, 2017 •

edited

Loading

mircolac commented Dec 4, 2017

leohxj commented Feb 1, 2018

leotm commented Feb 2, 2018

m-e-conroy commented Feb 9, 2018

MickL commented Feb 13, 2019 •

edited

Loading

SetTrend commented Mar 29, 2019 •

edited

Loading

beanmac commented Apr 5, 2019 •

edited

Loading

gazdagergo commented May 10, 2019 •

edited

Loading

isahilpahuja commented May 22, 2019

HTTP request

MIDDLEWARE

webia1 commented Jun 13, 2020

alexcroox commented Apr 27, 2022 •

edited

Loading

Jackie098 commented Mar 31, 2023

appsparkler commented Apr 7, 2023

Jackie098 commented Apr 7, 2023

Is it possible to 'get' data using POST with json-server? #453

Is it possible to 'get' data using POST with json-server? #453

Comments

vsharma2266 commented Jan 11, 2017

sanserna commented Mar 2, 2017

typicode commented Mar 2, 2017

hopkinson commented Apr 20, 2017 • edited Loading

vsharma2266 commented Aug 14, 2017

appsparkler commented Nov 9, 2017 • edited Loading

mircolac commented Dec 1, 2017 • edited Loading

HTTP request

MIDDLEWARE

appsparkler commented Dec 2, 2017 • edited Loading

mircolac commented Dec 4, 2017

leohxj commented Feb 1, 2018

leotm commented Feb 2, 2018

m-e-conroy commented Feb 9, 2018

MickL commented Feb 13, 2019 • edited Loading

SetTrend commented Mar 29, 2019 • edited Loading

beanmac commented Apr 5, 2019 • edited Loading

gazdagergo commented May 10, 2019 • edited Loading

isahilpahuja commented May 22, 2019

HTTP request

MIDDLEWARE

webia1 commented Jun 13, 2020

alexcroox commented Apr 27, 2022 • edited Loading

Jackie098 commented Mar 31, 2023

appsparkler commented Apr 7, 2023

Jackie098 commented Apr 7, 2023

hopkinson commented Apr 20, 2017 •

edited

Loading

appsparkler commented Nov 9, 2017 •

edited

Loading

mircolac commented Dec 1, 2017 •

edited

Loading

appsparkler commented Dec 2, 2017 •

edited

Loading

MickL commented Feb 13, 2019 •

edited

Loading

SetTrend commented Mar 29, 2019 •

edited

Loading

beanmac commented Apr 5, 2019 •

edited

Loading

gazdagergo commented May 10, 2019 •

edited

Loading

alexcroox commented Apr 27, 2022 •

edited

Loading