JSON API and schemas in Badgeyay
Repository
https://github.com/fossasia/badgeyay
New Features
- What feature(s) did you add?
Added JSON-API convention to the project and created several schemas.
JSON-API is a convention followed by developers while sending out their REST-API data. It signifies how and what must be given as an output data from an endpoint through your application. I also worked on simplifying the User Interface a bit. I also created a route for uploading default images in the flask backend. - What is JSON API?
JSON API is a format that works with HTTP. It delineates how clients should request or edit data from a server, and how the server should respond to said requests. A main goal of the specification (now at a stable v1.0) is to optimize HTTP requests; both in terms of the number of requests and the size of data packages exchanged between clients and servers. - How did you implement it/them?
I usedmarshmallow_jsonapito implement the JSON API standards in the project. It is a Python package that one can easily install in their system usingpip. After installing I created Schemas. Schemas are nothing but layers of abstraction over the data model that needs to be provided as an output from a particular endpoint. Json API standard is also followed since we are using EmberJS in the frontend.
Contributions
My Pull Request that are linked with this contribution are :
#863,#870,#878,#891,#903
Commit messages are a part of our scoring logic. Check here for the famous Linus Torvalds' tips about writing good commit messages.
Code commenting is also part of our scoring logic. In order to get higher utopian-io upvotes, make sure your code includes comments.
I see you have posted "please review." messages on every issue to project owners. We don't want any contributor to disturb the project owners. Even though, that's not the case for you, pinging owners for every issue withuot waiting a couple of days may be disturbing for the POs. Please next time, wait a couple of days before pinging them.
A tip about the contribution post; Before diving into about the changes you have made, it would be good to give some information about the project, what does it do, what is it good for, etc.
Thanks for the contribution!
Your contribution has been evaluated according to Utopian policies and guidelines, as well as a predefined set of questions pertaining to the category.
To view those questions and the relevant answers related to your post, click here.
Need help? Write a ticket on https://support.utopian.io/.
Chat with us on Discord.
[utopian-moderator]
Hey @emrebeyler
Here's a tip for your valuable feedback! @Utopian-io loves and incentivises informative comments.
Contributing on Utopian
Learn how to contribute on our website.
Want to chat? Join us on Discord https://discord.gg/h52nFrV.
Vote for Utopian Witness!
Hey @gabrum
Thanks for contributing on Utopian.
We’re already looking forward to your next contribution!
Contributing on Utopian
Learn how to contribute on our website or by watching this tutorial on Youtube.
Want to chat? Join us on Discord https://discord.gg/h52nFrV.
Vote for Utopian Witness!
Do you want me resteem your post to over 72,500 followers? Go here: https://steemit.com/@a-0-0