Strapi plugin logo for Populate deep

Populate deep

This plugin allows for easier population of deep content structures using the rest API.

Strapi plugin populate-deep

This plugin allows for easier population of deep content structures using the rest API.

Installation

npm install strapi-plugin-populate-deep

yarn add strapi-plugin-populate-deep

Usages

Examples

Populate a request with the default max depth.

/api/articles?populate=deep

Populate a request with the a custom depth

/api/articles?populate=deep,10

Populate a request with the a custom depth

/api/articles/1?populate=deep,10

Good to know

The default max depth is 5 levels deep.

The populate deep option is available for all collections and single types using the findOne and findMany methods.

Configuration

The default depth can be customized via the plugin config. To do so create or edit you plugins.js file.

Example configuration

config/plugins.js

1
2
3
4
5
6
7
module.exports = ({ env }) => ({
  'strapi-plugin-populate-deep': {
    config: {
      defaultDepth: 3, // Default is 5
    }
  },
});

Contributions

The original idea for getting the populate structure was created by tomnovotny7 and can be found in this github thread

Install now

npm install strapi-plugin-populate-deep

Last updated

21 days ago

Strapi Compatibility

Unavailable

Author

github profile image for Christofer Jungberg
Christofer Jungberg

Useful links

Create your own plugin

Check out the available plugin resources that will help you to develop your plugin or provider and get it listed on the marketplace.