Api-platform: how to output related entity id instead of resource path?

Question

How can I get the related entity Id instead of resource path?

For example, here's what I get now:

{
  "id": "/api/articles/0d8cb40c-221b-4c54-9e29-43877093b839",
  "type": "Article",
  "attributes": {
    "_id": "0d8cb40c-221b-4c54-9e29-43877093b839",
    "title": "Article",
    "content": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
    "dateCreated": "2018-07-17T18:20:29+03:00",
    "dateUpdated": "2018-07-17T18:20:29+03:00"
  },
  "relationships": {
    "author": {
      "data": {
        "type": "User",
        "id": "/api/users/b26e0381-6800-4f47-b269-9a92b27ad331"
      }
    }
  }
}

I would like to get related entity id like this:

"relationships": {
"author": {
  "data": {
    "type": "User",
    "id": "b26e0381-6800-4f47-b269-9a92b27ad331"
  }
}

Kévin Dunglas · Accepted Answer · 2023-08-02 12:09:27Z

5

API Platform 3 deprecated the allow_plain_identifiers option, but there is now a documentation page dedicated to this topic.

With API Platform 2, you can use the following configuration:

api_platform:
    allow_plain_identifiers: true

But note that:

it's discouraged: hypermedia APIs require to use URLs as identifiers
this option has been removed from API Platform 3: https://github.com/api-platform/core/pull/2022#issuecomment-398851861

edited Aug 2, 2023 at 12:09

answered Jul 17, 2018 at 23:09

Kévin Dunglas

3,0842 gold badges28 silver badges45 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Rayiez Over a year ago

Support for allow_plain_identifiers has been removed, Does not work now.

Kévin Dunglas Over a year ago

@Rayiez I just updated the answer for API Platform 3.

Collectives™ on Stack Overflow

Api-platform: how to output related entity id instead of resource path?

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related