Rest API Designs
In this article the general theme of it helps new or even current programmers understand the fundamentals of REST API’s and help make it more comprehensible as well as to remember important key points in this theme. From how to properly use HTTPS to getting to know how to construct it and remembering what errors you might have, what they mean, this article covers it all.
I selected this article because sometimes I like to look at things from a different perspective and search around to help me understand something in a different way to clarify a problem or to just maybe help me to connect the dots. Personally this article is a very good introduction into grasping the fundamentals of REST API’s. The material that was observed and taught in class as well as this article really made this click and helped me to move forward with this knowledge in the lessons ahead.
The article is set up perfectly to go in order of how to design a REST API and why per say the said details are important and it truly helped me to push forward in certain homeworks and as well as the assignments in class. The first operation is to make a simple URL that is simple and just easy. Following up is something that was surprisingly helpful and it was the importance of nouns that you needed to be aware of. This is sometimes being the most common mistake with developers. Tying into that is understanding when to use the right HTTPS methods and why said method should be used as well as why some are more useful than others. Diving to understand and help what parameters are and why we need them. HTTPS methods are just as important as the HTTP codes. Narrowing it down that the most important range of numbers that are used are from 200s all the way to the 500s. Moving to understanding versioning and why it’s very important because it helps keep a check on the amount of updates, small or big that lead to those said versions and helps tracking them when they come out. The last three titles are the use of pagination which helps understand the developer how downloading is going and if its causing any disruptions lowering the services that are in store. API responses must respond or return in JSON though that may vary if you are using a legacy app. The cherry on top is the using proper error messages. Practice and observe what error messages pull through.
Link:
https://betterprogramming.pub/restful-api-design-step-by-step-guide-2f2c9f9fcdbf
From the blog CS@Worcester – Site Title by Jon Skende and used with permission of the author. All other rights reserved by the author.