Getting image assets links using the API

[morismael]

Hello. Hope you're doing well. I want to thank you for this great product. It's really awesome.

I am building an ecommerce website with its own frontend so basically using Solidus API and Backend only. On the frontpage of the store website I wanna show the categories to allow customers to shop by category. I'm able to get the available categories (as Taxons) but the JSON response doesn't contain the icon of the taxon. Is there a way i could get this from the API request ? Otherwise how can I have this? Also is there a plan to provide this feature in the near future?

Thank you.

[kennyadsl]

Starting from Solidus 3.1 (#4039), we can configure the JSON response attributes of API's endpoints (including the ones related to taxons) with a standard preference.

In your config/initializers/spree.rb, you can add the following:

Spree::Api::Config.configure do |config|
  config.taxon_attributes += [ :api_icon_url ]
end

And defining a new method on the taxon to retrieve the right size of the icon that you want to use:

# app/overrides/your_store_name/spree/taxon/add_api_icon_url

module YourStoreName
  module Spree
    module Taxon
      module AddApuIconUrl
        def api_icon_url
          icon.url(:small) # :or :original
        end

        ::Spree::Taxon.prepend self
      end
    end
  end
end

which will be reflected in the corresponding jbuilder template. Please note that, the specific partial linked is also used elsewhere and depending on the attributes you'll add, it could cause some performance degradations of other endopoints as well.

⚠️ I didn't try this solution on a real application, so please let me know if this works or I missed anything.

[kennyadsl]

Can you try with just icon.url instead? Maybe I was wrong and :original is not a supported size.

[morismael]

Same error, with both variants or without none :-)

[Azeem838]

You might have to try either icon.rails_representation_url or if it requires a path then pass only_path: true.

There's also icon.service_url that you can try as well.

You might have to include the Rails url_helpers if these methods are missing.

[elia]

@morismael can you please share the full stack trace of the error, that's really useful in understanding where the error is originated 🔍

[morismael]

Sorry gents. It's my mistake I think. I had removed the icons from the sample taxons. Let me try get them back before I test again.

[morismael]

Issue solved: it was the attachment issue. After attaching images to taxons it's working fine. Many thanks.

[kennyadsl]

Thanks, can you please mark the comment as the answer?

[morismael]

Done 👍🏾