Shemiroth
Creating a new API
What is the process for designing and building a new API?
My last API I just jumped straight into a new project and started building endpoints. Now I have to make a new one and I am wondering if I should first define the endpoints using OpenAI specification or something? This one is going to be used by external users so I want to get it right with versioning and documentation.
I am also thinking about using Azure's Api Management https://learn.microsoft.com/en-gb/azure/api-management/api-management-key-concepts
21 replies
❔ Versioning for apps
I have been working on the same suite of apps for the last few years and have never had any versioning on the apps. I'd like to implement it now. I think using Jira's release feature and github branches for each release. I will create a release in Jira now 1.0.0 and start from that. It will cover all of the apps, so if I update our desktop app with a bug fix the version will just go to 1.0.1, then when I add a feature to the web app it will be 1.1.0, I guess 🤔
Does that sound about right or am I getting it wrong?
10 replies
❔ How much should a single test cover?
I've just finished making a integration test for some goods in functionality. So when we receive a delivery in the warehouse the operator will input how many of each item they accept or reject,
The test checks that when a item is accepted, it is added to stock details and if all items on the purchase order are accounted for it updates the status. It also check that when a item is rejected a new PO is raised and the status is set to rejected.
That's all fine.
Now there is also the possibility that a delivery being booked in will be linked to a job,. This is when we have sub contracted another company to do some work for us and they have delivered the finished product.
When that happens, the normal book in stuff above happens but then also the linked job will be updated.
That job update functionality is a beast of it's own. So the event chain for it is fired from the book in method if needed and I can test all of the stuff has been updated correctly.
So what I am wondering is... if my book in test is checking all of that job update stuff already. Is it worth making another test for that stuff or should I not bother testing it within the book in methods and just create specific tests for the job updates?
2 replies
