brharr / hotlineapi Goto Github PK

This is one project of two projects that makes up the Suspicious Activity Bot Application for Azure Commerical and Government. This particular project is the REST API that will be leveraged by either the Bot Application or any data retrieval No Code system to view and modify the records being stored. A full description of the project can be found in the following blog post: Deploying a Suspicious Activity Bot in Azure Commercial or Azure Government

I built these two projects to show how easy it is to create and deploy a Bot Application in either the Azure Commerical or Azure Government regions while also showing and discussing the differences. See the blog post above for more information.

These instruction will allow you to deploy this application directly from Github into an Azure App Service, either Web App or API App. Knowledge of Azure App Service is required:

• Create a new Azure App Service
• Setup Continuous Deployment from Github Repo
• Add a New Connection String setting to the App called CUSTOMCONNSTR_docdb

NOTE: Please note that I am assuming that you already have either a MongoDB database available or a MongoDB based CosmosDB instance available to get the necessary connection string from.

• NodeJS - Development engine and application server
• Express - The web framework used
• Mongoose - MongoDB based ORM library
• MongoDB - Database system

This is a very simple REST API with a route for all four of the major verbs, but as there is only one data model, the options are very limited:

• GET - https:///apis/incidents
• POST - https:///apis/incidents
• GET - https:///apis/incidents/:id
• PUT - https:///apis/incidents/:id
• DELETE - https:///apis/incidents/:id

The id parameter being passed of the incident is the default parameter created for all MongoDB records.

This project is meant to be consumed and then modified on a per customer or developer basis. Please feel free to either file an Issue or perform a Pull request should you find a bug or would like to make an enhancement on your own.