Practice App: Feature- Search by tag API

[BElifb]

What's up?

As discussed in meeting notes #14 I will create the API for search by tag. Given a tag name this API will return a list of all of the art items tagged with that tag (in json format).

API endpoint	API Method	API Description
api/searchbytag/<str:tag>	GET	Return all of the art items with the given tag name

To Do

• Create new branch feature/search_by_tag off of practice_app.
• Add the URL for the endpoint.
• Create the corresponding view.
• Use api decorators.
• Write unittests for the API.
• Test them out.
• Create Pull request and assign to @KarahanS as reviewer as stated in meeting notes #14

Deadline

Creation: 15.05.2022 @21.00
Testing: 17.05.2022 @21.00
Review: 18.05.2022 @21.00

Additional Information

No response

Reviewers

@KarahanS

[BElifb]

• url works with the name of the tag not the id. If you're having trouble with tag names make sure it is encoded in the url format. Such as # -> %23. For reference https://www.w3schools.com/tags/ref_urlencode.asp
• Added urlpatterns = format_suffix_patterns(urlpatterns, allowed=['json', 'html']) to urls.py in order to give us the option to choose between default Response template and regular json
• Extend the url with <?format=json> to get json
• If you're having any trouble with your views make sure you added format=None to the arguments

[BElifb]

• Added tests folder to api.
• Created unit tests for search_by_tag.
• Ran the test.
• Created fake data for the test.
• Test compares the result status and the data to make sure they are equal as expected.
• Use py manage.py test api to run the test.

[BElifb]

• Implemented a frontend page, to get the requested tag name with user interface. Please refer to #111

[BElifb]

• Created pull request #114

[KarahanS]

With PR #128, another tag related functionality is added: api/v1/searchbytagkeyword/<str:tag>.
It's inspired by the API endpoint given above. It returns all of the art items including the given keyword.

[BElifb]

• Changed/added some error messages for the API.
• In accordance with that added some more tests and ran them.
• Related commit here.

[KarahanS]

Practice App Implementation is over. No action is taken, closing the issue.