Following API best practices

This commit is contained in:
xfarrow
2024-03-06 10:19:37 +01:00
parent 4f53ef7561
commit ae14f04949
10 changed files with 46 additions and 38 deletions

View File

@ -1,8 +1,5 @@
# APIs
## Programming language
The Blink APIs are currently written in NodeJS only.
## Prerequisites
* PostgreSQL;
* NodeJS.
@ -16,3 +13,8 @@ In order to deploy the Blink APIs, follow these steps:
You can test the APIs in two ways:
* Open `BlinkApiUsageExample.json` with Insomnia or Bruno in order to have the collection of APIs already configured and ready to be seen in action;
* Run `npm test` in `./nodejs` to run a suite of automated tests.
## For Developers
The current implementation of the Blink APIs is written in NodeJS. Feel free to develop them in any other
programming language (you can paste the folder here) but make sure to make them compatible with one another
and please follow the API design [best practices](https://learn.microsoft.com/en-us/azure/architecture/best-practices/api-design)