Improving routes page

[lcpichette]

What does it do?

Updated the handler names in the Configuration section and added a reference to a strapi command that allows you to view all existing routes and their current hierarchal order in the top-level/introductory section (above Implementation).

Why is it needed?

I was told in office hours that the existing handler name I had was incorrect, but it matched the docs. I was then suggested to use the following format api::whatever.whatever.yourFunction.

Knowing what the api::whatever.whatever part is can be kind of confusing -- when do I use singular/plural for my collection-types? Do I use my file name or the collection name? I was told of a really helpful command to see if my routes exist -- and what they're labeled as (e.g. api::whatever.whatever): yarn strapi routes:list

Related issue(s)/PR(s)

It is something I discovered was an issue during office hours.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
documentation	🛑 Canceled (Inspect)			May 2, 2024 8:54am

[strapi-cla]

All committers have signed the CLA.

[pwizla]

Thanks for the contribution, @lcpichette!

Regarding your question about using singular/plural, I'd say it all depends on how you called your content-type and controller 😅 The name/path of the file is what is important.

If you used singular (for instance when you create the content-type either with the Content-Type Builder or with the strapi generate interactive CLI), it will be singular.
This is for instance the case for the restaurant content-type created throughout our docs, and also used in the examples/getstarted code in the strapi/strapi repo:

You can also have a look at my screenshot, as a test I created a "livre" (singular) content-type and the code is using "livre":

If, for some specific reasons, your "default" name is already plural (which I won't recommend), like creating a "tables" content-type, the uid will use this plural version:

Oh, and we opted for a "generic" controllerName naming because it actually depends on whether you use an API controller or a plugin controller. See usage here.

FYI the strapi routes:list is mentioned in the CLI reference guide: https://docs.strapi.io/dev-docs/cli#strapi-routeslist. You can also use other list-type commands.

I understand this might all be a bit confusing and there are lots of pieces working together and customization possibilities. Your PR will be helpful (and I'll slightly tweak it to include the plugin use case).

[pwizla]

The PR is now approved, merged, should be live on docs.strapi.io in a few minutes, and will be mentioned in the next weekly snapshot release.