Added ability for username to act as identifier for API user detail endpoint in addition to primary key (/api/users/<userID> OR /api/users/<username>)
#321
Conversation
There was a problem hiding this comment.
What if a user goes by the name "1234"? That could cause an issue with searching for the correct user. A better implementation could have you search through user name first and store usernames as "User#user_id" That way you can query id numbers by using the #, and we can exclude # from potential username characters.
There was a problem hiding this comment.
I just made a commit that validates the User's username, and ensures that it cannot be fully numeric. This way, we will not have this problem, as a given URL parameter can only be interpreted as either a username OR an id but not BOTH.
NOTE: This commit is in PR #291, because in that PR, I created the username field for the User model, so it is only consistent that I put restrictions on the username field in that PR.
There was a problem hiding this comment.
You must reach out to the users team before I will approve any changes to the User model.
| def get_object(self): | ||
| lookup_value = self.kwargs.get(self.lookup_field) | ||
|
|
||
| # If the lookup_value is an integer, use the id field |
There was a problem hiding this comment.
This works as expected!
I can POST users with unique usernames/email while having overlapping names, then go to api/users/<username> and get their detail view.
While still being able to access api/users/<pk>
Great work and keep moving forward! We're almost done!
|
Issue Score: Excellent Comments: |
|
Closing Comment: Successfully, completed the |
Goal: In this PR, we allow users of the API to access the Detail view of a given
Userobject using the user'susernameas a slug instead of always having to use the user'sid. For a user of the API to get a givenUser's ID, they need to go through the entire List view of user's and find the specificUserthey are looking for and then look at theidof thatUser.The
usernameon the other hand, is a unique identifier for aUserobject, that is human readable and can be shared/accessed easily. This way, it is easier for someone that uses the API to get details of a specific user, as one does not need to know it's primary key in the model.We will support:
/api/users/<user_id>AND/api/users/<username>to GET/PATCH/DELETE the Detail view of theUserwith the givenidorusername