https://github.com/softkitit/strapi-plugin-deep-populate
https://github.com/softkitit/strapi-plugin-deep-populate
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/softkitit/strapi-plugin-deep-populate
- Owner: softkitit
- License: mit
- Created: 2026-02-28T16:33:22.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-03-13T23:54:12.000Z (3 months ago)
- Last Synced: 2026-04-19T01:39:49.785Z (2 months ago)
- Language: JavaScript
- Size: 85.9 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @softkit/strapi-plugin-populate-deep
This plugin allows for easier population of deep content structures using the rest API.
# Installation
`pnpm add @softkit/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`
```
module.exports = ({ env }) => ({
'@softkit/strapi-plugin-populate-deep': {
config: {
defaultDepth: 3, // Default is 5
}
},
});
```
# Contributions
The original idea for getting the populate structure was created by [tomnovotny7](https://github.com/tomnovotny7) and can be found in [this](https://github.com/strapi/strapi/issues/11836) github thread