Skip to content
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

Provide an example of custom request URL with RestClient in the reference guide #32685

Closed
wosiwq opened this issue Apr 22, 2024 · 3 comments
Closed
Labels
in: web Issues in web modules (web, webmvc, webflux, websocket) type: documentation A documentation task
Milestone

Comments

@wosiwq
Copy link

wosiwq commented Apr 22, 2024

Affects: 6.1.3

I'm currently working with the Spring RestClient and I'm curious about the best practice for performing a GET request with parameters. While it's straightforward to perform a basic GET request, I couldn't find clear documentation or examples regarding how to include parameters in the request.

Could someone please provide guidance or an example of how to properly perform a GET request with parameters using the Spring RestClient? It would be immensely helpful for understanding the best practices and ensuring compatibility with various API endpoints.

Thank you in advance for your assistance!

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label Apr 22, 2024
@snicoll
Copy link
Member

snicoll commented Apr 22, 2024

The Request URL section of the doc introduces this concept. It provides a link to a more dedicated section.

This SO question provides an example.

That all being said, I agree the doc could be a bit more explicit here, perhaps with a small example?

@snicoll snicoll added type: documentation A documentation task in: web Issues in web modules (web, webmvc, webflux, websocket) and removed status: waiting-for-triage An issue we've not yet triaged or decided on labels Apr 22, 2024
@snicoll snicoll added this to the 6.1.x milestone Apr 22, 2024
@snicoll snicoll changed the title Inquiry about GET method with parameters in Spring RestClient Provide an example of custom request URL with RestClient in the reference guide Apr 22, 2024
@wosiwq
Copy link
Author

wosiwq commented Apr 22, 2024

Thank you for your prompt response and the helpful information! I appreciate the clarification on where to find the concept of including parameters in the Request URL section of the documentation and the link to the SO question for an example.

I completely agree that the documentation could benefit from a more explicit example to better illustrate this concept for users like myself. Would it be possible to consider adding a small example in the documentation for clarity?

@snicoll
Copy link
Member

snicoll commented Apr 23, 2024

I decided to provide a more explicit link in the end as the existing page is providing more example I could add in that section.

@jhoeller jhoeller modified the milestones: 6.1.x, 6.1.7 Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: web Issues in web modules (web, webmvc, webflux, websocket) type: documentation A documentation task
Projects
None yet
Development

No branches or pull requests

4 participants