Add custom constraint example #3539
Conversation
WalkthroughThe documentation for Fiber v3 has been updated to introduce a new section detailing how to implement and use Custom Route Constraints. This includes an example of creating and registering a custom constraint for route parameter validation, without modifying any existing content or code. Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant FiberApp
Developer->>FiberApp: Implement CustomConstraint interface
Developer->>FiberApp: RegisterCustomConstraint("ulid", UlidConstraint)
Developer->>FiberApp: Define route with :id<ulid>
FiberApp->>FiberApp: Validate route parameter using UlidConstraint
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for registering custom route constraints in the Fiber app.
- Introduces a new section on custom route constraints in the changelog.
- Provides a sample implementation of a custom constraint (UlidConstraint) and usage within a route definition.
Comments suppressed due to low confidence (1)
docs/whats_new.md:92
- [nitpick] Consider adding a note or import statement for the 'ulid' package to clarify which package provides ulid.Parse, ensuring readers are not confused about missing context.
_, err := ulid.Parse(param)
|
@efectn ok ? |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @ReneWerner87, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request focuses on enhancing the project's documentation by providing clear guidance and an illustrative example for implementing custom route constraints. This will help users understand how to extend the routing capabilities with their own validation logic, making the framework more flexible and easier to customize.
Highlights
- Documentation Enhancement: Expanded the
docs/whats_new.mdfile to include comprehensive documentation on how to implement and register custom route constraints within the Fiber framework. - Practical Example: Provided a detailed Go code example within the documentation, illustrating the creation of a
UlidConstraintand its integration into a Fiber application's routing, demonstrating both registration and usage.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request adds documentation for custom route constraints in the Fiber framework. The documentation includes an example of how to register a custom route constraint using the RegisterCustomConstraint method and how to implement the CustomConstraint interface. The changes look good and provide a useful addition to the Fiber documentation.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/whats_new.md (2)
74-78: Add TOC link for Custom Route Constraints
The new section isn’t referenced in the top-level overview under “🚀 App”. Consider adding a nested bullet under the App entry in the TOC for quick navigation:- [🚀 App](#-app) + - [Custom Route Constraints](#custom-route-constraints)
79-101: Enhance example with imports and API doc links
The code snippet skips import statements and direct links to the API docs. For completeness and clarity, include:import ( "github.com/gofiber/fiber/v3" "github.com/oklog/ulid" )And reference the API docs inline:
Use [`RegisterCustomConstraint`](./api/app#registercustomconstraint) to add a constraint type that implements the [`CustomConstraint`](./api/app#customconstraint) interface.
Summary
Testing
make test(fails: signal interrupt)https://chatgpt.com/codex/tasks/task_e_6858feaa4f708326bceb321ff687bb6d