Skip to content

Added custom web routes documentation #60

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.

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 6 commits into from
May 9, 2025

Conversation

sirzento
Copy link
Contributor

I don't know if that's wanted but you can never have enough documentation 😄

Preview:

Screenshot 2025-04-15 at 09-40-24 Documentation - Blueprint

@prplwtf
Copy link
Member

prplwtf commented May 6, 2025

Hiya! Having this as part of our guides would actually come really useful!

Could you make the changes I requested in previous PRs?

@prplwtf prplwtf self-requested a review May 6, 2025 10:18
@prplwtf prplwtf added the documentation Improvements or additions to documentation label May 6, 2025
Copy link
Member

@prplwtf prplwtf left a comment

Choose a reason for hiding this comment

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

For reference on what actually handles routes: https://github.com/BlueprintFramework/framework/blob/main/app/Providers/Blueprint/RouteServiceProvider.php

Prefixes for route options are:

  • web: /extensions/identifier
  • application: /api/application/extensions/identifier
  • client: /api/client/extensions/identifier

Web is available to everyone (even users that aren't logged in) unlike application and client, which are limited to valid API keys.

This is not required to have in the guide, but useful for you to know; Binding a route file directly to routers: instead of any of it's suboptions defaults to the routers:web suboption.

@sirzento
Copy link
Contributor Author

sirzento commented May 9, 2025

Alright, requested changes are done

grafik

Copy link
Member

@prplwtf prplwtf left a comment

Choose a reason for hiding this comment

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

lgtm

@prplwtf prplwtf merged commit 2cd63ab into BlueprintFramework:main May 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants