A simple Pip Sample Beacons Application that serves two purposes:
- It can be used as the template when creating new projects
- It is a reference for building and publishing custom microservices
The microservice contains list of beacons where each becaon have basic information and absolute location.
The microservice currently supports the following deployment options:
- Deployment platforms: Standalone Process, Docker
- External APIs: HTTP/REST
- Persistence: Memory, Flat Files, MongoDB
- Logging, Maintaining
- Download Links
- Development Guide
- Configuration Guide
- Deployment Guide
- Client SDKs
- Communication Protocols
Logical contract of the microservice is presented below and define in Interface project. For physical implementation (HTTP/REST, Lambda, etc.), please, refer to documentation of the specific protocol.
public class BeaconV1 : IStringIdentifiable
{
public string Id { get; set; }
public string SiteId { get; set; }
public string Type { get; set; }
public string Udi { get; set; }
public string Label { get; set; }
public CenterObjectV1 Center { get; set; }
public double Radius { get; set; }
}
public class CenterObjectV1
{
public string Type { get; set; }
public double[] Coordinates { get; set; }
}
public interface IBeaconsClientV1
{
Task<DataPage<BeaconV1>> GetBeaconsAsync(string correlationId, FilterParams filter, PagingParams paging);
Task<BeaconV1> GetBeaconByIdAsync(string correlationId, string id);
Task<BeaconV1> GetBeaconByUdiAsync(string correlationId, string udi);
Task<CenterObjectV1> CalculatePositionAsync(string correlationId, string siteId, string[] udis);
Task<BeaconV1> CreateBeaconAsync(string correlationId, BeaconV1 beacon);
Task<BeaconV1> UpdateBeaconAsync(string correlationId, BeaconV1 beacon);
Task<BeaconV1> DeleteBeaconByIdAsync(string correlationId, string id);
}Step 1. Install Docker Desctop
Step 2. Execute following command to download Docker image with predefined microservice and run
git docker run pip-templates-microservice-dotnetMore information about how to configure microservice and run in docker container can be found in Deployment Guide
Prerequisite:
- Download and install .Net Core SDK.
- Download and install Visual Studio for Mac or Visual Studio Community.
Step 1. Check it out latest source code directly from github repository
git clone [email protected]:pip-templates/pip-templates-microservice-dotnet.gitStep 2. Compile source code
dotnet build ./pip-samples-beacons.slnStep 3 Run compuled binaries
cd ./src
dotnet ./Process/bin/Debug/netcoreapp2.1/run.dllAdd beacons
curl --header "Content-Type: application/json" --request POST --data "{\"correlationId\":\"d42fd72c-02d2-4944-8631-4d94bc5fd75f\",\"beacon\":{\"id\":\"1\", \"site_id\":\"Site1\", \"type\":\"tracker\",\"udi\":\"12345\", \"label\":\"basic tracker\", \"radius\":4.0, \"center\": {\"type\": \"absolute\", \"coordinates\": [123.0,456.0,789.0]}}}" http://localhost:8080/v1/beacons/create_beacon
curl --header "Content-Type: application/json" --request POST --data "{\"correlationId\":\"d42fd72c-02d2-4944-8631-4d94bc5fd75f\",\"beacon\":{\"id\":\"2\", \"site_id\":\"Site2\", \"type\":\"tracker\",\"udi\":\"12345\", \"label\":\"basic tracker\", \"radius\":4.0, \"center\": {\"type\": \"absolute\", \"coordinates\": [123.0,456.0,789.0]}}}" http://localhost:8080/v1/beacons/create_beaconGet all beacons
curl --header "Content-Type: application/json" --data "{\"correlationId\":\"d42fd72c-02d2-4944-8631-4d94bc5fd75f\",\"filter\":null,\"paging\":null}" --request POST localhost:8080/v1/beacons/get_beaconsUpdate beacon
curl --header "Content-Type: application/json" --request POST --data "{\"correlationId\":\"d42fd72c-02d2-4944-8631-4d94bc5fd75f\",\"beacon\":{\"id\":\"2\", \"site_id\":\"New Site2\", \"type\":\"tracker\",\"udi\":\"12345\", \"label\":\"basic tracker\", \"radius\":4.0, \"center\": {\"type\": \"absolute\", \"coordinates\": [123.0,456.0,789.0]}}}" http://localhost:8080/v1/beacons/update_beaconGet beacon
curl --header "Content-Type: application/json" --data "{\"correlationId\":\"d42fd72c-02d2-4944-8631-4d94bc5fd75f\",\"beacon_id\":\"2\"}" --request POST localhost:8080/v1/beacons/get_beacon_by_idDelete beacon
curl --header "Content-Type: application/json" --data "{\"correlationId\":\"d42fd72c-02d2-4944-8631-4d94bc5fd75f\",\"beacon_id\":\"2\"}" --request POST localhost:8080/v1/beacons/delete_beacon_by_idThis microservice was created and currently maintained by Sergey Seroukhov, Sergey Merkuriev, Egor Nuzhnykh.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent