spring-projects / spring-projects/spring-hateoas
Support arbitrary path appends with LinkBuilder
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 476
- PR merge metrics
- No merged PRs in 30d
Description
If i'm violating a best practice or design principle, by all means, let me know. On occasion, I find a need to have an arbitrary path that doesn't necessarily represent an entity. For example, let's say I have an API for files.
Call GET on /api/files/{id} and a JSON representation of the file's metadata is returned.
Call GET on /api/files/{id}/data and the file is actually sent to the client as application/octet-stream or whatever content type is appropriate.
I'd like to include a link to /api/files/{id}/data in the /api/files/{id} result.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the LinkBuilder entry point and reading how it currently constructs links for entity resources. Trace the existing tests or examples for link building, then verify that an arbitrary path such as /api/files/{id}/data can be appended and represented in the resulting link.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring
- Domain
- backend-api-design
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100