custom resource id - Githubissues

mvestil commented 8 years ago

Currently, an option to set a custom id is provided using commandline option --id id

Is it possible to make id set to a format something like this :

--id resource_id where resource is the name of the resource...

So when you run json-server db.json --id resource_id, the below json db is valid

{
  "posts": [
    { "post_id": 1, "title": "json-server", "author": "typicode" }
  ],
  "comments": [
    { "comment_id": 1, "body": "some comment", "post_id": 1 }
  ],
  "profile_id": { "name": "typicode" }
}

mertkahyaoglu commented 8 years ago

We could also create a ids.json file and specify the each id of the resources like this

{
  "posts": "post_id",
  "comments": "comment_id"
}

I think this would allows us to create more generic ids, not just ones that follow some pattern.

JulienBrks commented 8 years ago

how to use ids.json @mertkahyaoglu

mertkahyaoglu commented 8 years ago

json-server db.json --id ids.json could work, like --routes routes.json

if we want all of the resource ids to be same, we could just create a json file like this;

{
  "id": "custom_id"
}

@JulienBrks

JulienBrks commented 8 years ago

I tried but not work. And I can't find doc about this way to use --id. May you give a demo or a detail doc link. @mertkahyaoglu

mertkahyaoglu commented 8 years ago

@JulienBrks Oh, it was just a suggestion. json-server does not have this feature, but it would be great to have. Sorry about the confusion.

hadynz commented 8 years ago

👍 for an ids.json

odranoelBR commented 8 years ago

:+1: for an ids.json

inNetto commented 8 years ago

:+1: for an ids.json

barrozorcb commented 8 years ago

:+1: for an ids.json

mouradsm commented 8 years ago

:+1: for an ids.json

helloheesu commented 7 years ago

(👍 for ids.json,) Is it being worked? or even not considered? 😢

inNetto commented 7 years ago

did u improved it? it could be awesome

2017-01-12 5:14 GMT-02:00 Heesu Jung notifications@github.com:

(👍 for ids.json,) Is it being worked? or even not considered? 😢

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/typicode/json-server/issues/279#issuecomment-272093320, or mute the thread https://github.com/notifications/unsubscribe-auth/AGN88SK_CScf60t-2fHq7ZYeXauSoNvwks5rRdLkgaJpZM4IZ3ub .

shyDn commented 7 years ago

for an ids.json, it's so great and helpful for us 👍

alexandermikuta commented 7 years ago

This would be really helpful.

markudevelop commented 7 years ago

+1

pavel06081991 commented 7 years ago

+1

FranciscoGregorio commented 7 years ago

+1

Ginxo commented 7 years ago

+1

kitayu commented 7 years ago

+1

StefanDuPreez commented 7 years ago

+1

typicode commented 7 years ago

Thank you for all the feedback 👍

JSON Server now supports a --foreignKeySuffix option, which lets you define how the foreign key should end (making it easier to fake Rails APIs for example).

{
  "posts": [ { "id": 1 } ]
  "comments": [ { "id": 1, "post_id": 1 } ]
}

json-server db.json --fks _id

GET /posts/1/comments

Nezteb commented 7 years ago

@typicode I don't think that's what people in this thread are referring to. They want to be able to rename primary keys to something other than "id". The --id flag doesn't work for me either.

{
    "posts": [
        { "postId": 1, "title": "Hello world" },
        { "postId": 2, "title": "Hello other world" },
        { "postId": 3, "title": "Goodbye world" }
    ]
}

In this case, /posts/1 returns {}. I've also tried post_id with --id "_id".

zhenik commented 7 years ago

That works for me. Exact command that I use json-server mocked_db.json --id _id --port 3004 ?

chfw commented 6 years ago

Having the same need in the program too. It is solved by these:

const server = jsonServer.create();
const router = jsonServer.router('dummy.json'); 
router.db._.id = "yourCustomIdField";
server.use(router);

FrancescoBorzi commented 6 years ago

It would be nice to have this feature. In particular it would be nice to be able to set different ID param names for different entities.

For example:

{
  "posts": [
    { "postId": 1, "title": "json-server", "author": "typicode" }
  ],
  "comments": [
    { "commentId": 1, "body": "some comment", "postId": 1 }
  ]
}

in this case I would like to assign postId as id key for the "posts" entities, and commentId as id key for "comments" entities

fehrinjt commented 6 years ago

Has there been any traction on this? I'm very in favor of a solution to have an ids.json file that would map each resource to it's own custom ID.

Gabriel-Cheung commented 6 years ago

I overwrote the render function of router to return the custom id as I want without much effort. It is still storing the data with 'id', but returning with custom id.

import _ from 'lodash';

const idMappings = {
    posts: "postId",
    comments: "commentId",
};

router.render = (req, res) => {
    const entity = req.path.split('/')[1];
    let data;
    if(_.isArray(res.locals.data)) {
        data = _.map(res.locals.data, (item) => {
            item[idMappings[entity]] = `${item.id}`;
            delete item.id;
            return item;
        });
    } else {
        data = res.locals.data;
        data[idMappings[entity]] = `${data.id}`;
        delete data.id;
    }
    res.jsonp({
        data,
    });
};

tomeustace commented 6 years ago

I needed a quick way to keep my ids in sync, below is inspired by and similar to above but as middleware:

'use strict'
// idMappings.js

// read --ids as JSON, e.g. json-server db.json --ids '{ "posts": "postsId", "comments": "commentsId" }'
let index = process.argv.indexOf('--ids');
let idMappings = process.argv[index + 1];
idMappings = JSON.parse(idMappings);

module.exports = (req, res, next) => {
  if (req.method === 'POST' || req.method === 'PUT') {
    const entity = req.path.split('/')[1];
    req.body.id = req.body[idMappings[entity]];
  }
  next()
}

Run


json-server --watch db.json --ids '{"posts":"postsId", "comments": "commentsId"}' --middlewares idMapping.js

capJavert commented 6 years ago

My implementation, merging tomeustace and other ideas above. Put this in server.js or other file and run as node server.js. db.json will still contain "iternal id" column but each request and response will be remapped.

This was a quick and dirty fix, I think that this req path parsing could be improved to support more complex resource urls.

const jsonServer = require('json-server');
const server = jsonServer.create();
const path = require('path');
const router = jsonServer.router(path.join(__dirname, 'db.json'));
const middlewares = jsonServer.defaults();

// define primary key columns for each resource
const primaryKeys = {
  "countries": "code",
  "towns": "id",
  "access-policies": "accessPolicyId",
  "device-services": "id"
};

const port = 3200;

server.use(middlewares);
server.use(router);
server.listen(port, () => {
  console.log('Test server is running on port: ' + port)
});

router.render = (req, res) => {
  const resource = req.path.split('/')[1];
  let filteredResponse = res.locals.data;

  // remapping internal id columns to dedicated resource columns
  if (req.method === 'POST' || req.method === 'PUT') {
    req.body.id = req.body[primaryKeys[resource]];
  } else if (req.method === 'GET') {
    filteredResponse = filterResponse(resource, res.locals.data);
  }

  // optional response wrapping to data attribute
  res.jsonp({
    data: filteredResponse
  });
};

function filterResponse(resource, response) {
  // don't filter if primaryKey is same as internal
  if (primaryKeys[resource] === 'id') {
    return response;
  }

  if (response instanceof Array) {
    for (let i=0;i<response.length;i++) {
      delete response[i].id;
    }
  } else {
    delete response.id;
  }

  return response;
}

ausmurp commented 6 years ago

@typicode how can we use foreignKeySuffix when running json-server as module? Also can we add json-server.json config when running as module? I've added {"foreignKeySuffix":"_id"} in json-server.json but it's still not working..