We’ve been building REST APIs for some of our projects. One of the struggles that I’ve personally faced was deciding on the URL structure for the endpoints. After some trials and errors and learning from others, here is a set of conventions that I think we should follow.
Recently, I built a program that directly interacts with OpenStack cloud operations and its various components. It was a solid learning experience, and I want to share what I learned so future ARCsoft developers can hit the ground running.
At ARCsoft we have begun building a repository of custom Helpers libraries that will be included in future projects. First on the docket was looking at several giant UI test code blocks in Django. These often span dozens of modules and thousands of lines of code. Quite common throughout was the use of repetitive and non-descriptive JsonResponse calls. Let’s walk through how we compartmentalized these calls into a more cohesive set of custom JsonResponse classes and how we added them to our repository of custom methods that we will use here at ARCsoft. Along the way we will document the setup of the Helpers repository and the essential inclusions to a project for the package to be able to be used, imported, and published.