How to add external Resource

dotronglong

I am checking a possible way to add customised resources to included section of apiDocument

At the beginning, I tried to check WillSerializeData event, but it will be overridden later. Additionally, I cannot pull out Resource to add.

datitisev

dotronglong The included data in a JSON API response are the relationships that have been chosen to be included in the response. See if our documentation for adding Relationships and adding them to serialiers helps.

dotronglong

datitisev thank you for your information. I meant that I want to add customised resource, it might not have any relationships with current active resource (for instance, a special object like promotion).

clarkwinkelmann

dotronglong which requests do you want to add additional data to ?

included contains data referenced in the relationship(s) of the resources returned in data, so there's no way to put something there that's not referenced.

If you want to add data to the global forum resource, take a look at how the Tags extension adds a relationship to the forum that loads all tags. Or how core loads groups. Or how Mason loads all fields in the same manner. Or how Catch The Fish loads the active rounds. Basically they all add a serializer relationship, but it's not linked to any Eloquent relationship, the data is "hard-coded".

If you want to return a mix of various resources from a new API endpoint, you should be able to use an IndexController and somehow use different serializers for different items. While it would be valid, that's not a typical way of using the JSON:API spec in Flarum.

dotronglong

clarkwinkelmann thank you, I looked tags extension, it seems temporary suitable for my needs now. 😄