Skip to content

don't generate default routes when generating plugin api #5586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 25, 2020
Merged

don't generate default routes when generating plugin api #5586

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
760e89f
don't generate default routes when generating plugin api
Mar 24, 2020
057ec58
remove console log
Mar 24, 2020
371fc94
Merge branch 'master' into fix/#3965/brokenScaffoldingApiOnPlugin
alexandrebodin Mar 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
don't generate default routes when generating plugin api 
Signed-off-by: Pierre Noël <pierre.noel@strapi.io>
  • Loading branch information
Pierre Noël committed Mar 24, 2020
commit 760e89fb4a7300b0c3c7da8b43e7f2bd14b2cd32
50 changes: 12 additions & 38 deletions packages/strapi-generate-api/json/routes.json.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,46 +97,20 @@ function generateCollectionTypeRoutes({ route, name }) {
*/

module.exports = scope => {
const routes =
scope.contentTypeKind === 'singleType'
? generateSingleTypeRoutes({
route: scope.route,
name: scope.name,
})
: generateCollectionTypeRoutes({
route: scope.route,
name: scope.name,
});
let routes = [];
if (!scope.args.plugin) {
Copy link
Contributor

@sunnysonx sunnysonx Nov 12, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @alexandrebodin & @petersg83, What's the reason for disabling the API routes generation inside plugins? Is there any known issue with it? I've deleted that if (!scope.args.plugin) { locally and it seems to generate/merge existing routes for plugins ok.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the plugin models don't get auto generated controllers those default routes point to nothing. There was no reason to generate them :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In that case, it also brokes the functionality of the strapi generate:api order --plugin shop command, which should create a new API inside the plugin, it doesn't generate the routes for it automatically.

routes =
scope.contentTypeKind === 'singleType'
? generateSingleTypeRoutes({ route: scope.route, name: scope.name })
: generateCollectionTypeRoutes({ route: scope.route, name: scope.name });
}

// We have to delete current file
// if routes.json already exists, then merge
if (fs.existsSync(scope.rootPath)) {
let current;

try {
// Copy current routes.json
current = require(scope.rootPath);

// Remove current routes.json
fs.unlinkSync(scope.rootPath);
} catch (e) {
console.error(e);
current = {
routes: [],
};
}

try {
_.set(
current,
'routes',
_.concat(routes, _.differenceWith(current.routes, routes, _.isEqual))
);

return current;
} catch (e) {
console.error(e);
return;
}
console.log('pouet');
let current = require(scope.rootPath);
fs.unlinkSync(scope.rootPath);
routes = _.concat(routes, _.differenceWith(current.routes, routes, _.isEqual));
}

return { routes };
Expand Down