-
Notifications
You must be signed in to change notification settings - Fork 313
refactor: refactor FastAPI route setup and docs #280
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
refactor: refactor FastAPI route setup and docs #280
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @martimfasantos, 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 introduces a significant refactoring to the A2AFastAPIApplication class, specifically within its add_routes_to_app method. The primary goal is to simplify the way FastAPI routes are defined and to improve the auto-generated Swagger documentation, making the codebase more readable and maintainable.
Highlights
- Route Definition Simplification: The
add_routes_to_appmethod inA2AFastAPIApplicationhas been refactored to directly associate handler methods (self._handle_requests,self._handle_get_agent_card,self._handle_get_authenticated_extended_agent_card) with FastAPI route decorators (app.postandapp.get). - Code Readability and Maintainability: Unnecessary nested
async deffunction definitions that previously wrapped the actual handler methods have been removed, leading to cleaner and more concise route declarations. - Improved Documentation: This refactoring enables method descriptions to appear correctly in the Swagger documentation, enhancing the developer experience and API discoverability.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request refactors the FastAPI route registration in A2AFastAPIApplication. The change simplifies the code by removing wrapper functions and directly associating the handler methods with the route decorators. This is a great improvement for code clarity and maintainability. As a key benefit, this change allows FastAPI to correctly generate endpoint descriptions from the handler docstrings for the OpenAPI documentation, which significantly improves the developer experience. The implementation is clean, correct, and achieves its goals effectively. I have no concerns with this change.
Description
Summary
This PR improves the current implementation of
A2AFastAPIApplicationclass that enables serving A2A endpoints using a FastAPI application. (#104)Implementation Details
Refactors the
add_routes_to_appmethod insrc/a2a/server/apps/jsonrpc/fastapi_app.pyto simplify route definitions by:self._handle_requests,self._handle_get_agent_card, andself._handle_get_authenticated_extended_agent_card) to the FastAPI decorators (app.postandapp.get)These changes make the code more readable, maintainable, and better integrated with FastAPI's documentation features.
Screenshots
Before
After
Continues #104 🦕