This simple WebAPI provides the registration and authentication functionalities. Was created just for experimental and education purposes. The Authentication API are based on JWT with assymentic RSA encryption. Private/public .pem files you can find in the .keys directory. The project isn't ideal and has a lot of stuff to improve. Periodically, I update it with new features/bugfixes/refactorings and performance improvements.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Options to build and run the application:
1. Docker/Kubernetes
2. .Net 5 SDK
Assuming, you're located in the root folder, run the next commands:
cd docker-compose
docker-compose up --build
If you use local Kubernetes cluster, you may use already defined manifests from .k8s folder to run the application. To build yaml files, Kustomize is used. To access API endpoints, you need to have NGINX ingress controller to be installed and the hosts file updated to use the DNS name. For more info about NGINX ingress controller visit https://kubernetes.github.io/ingress-nginx/
Add these lines to your hosts file:
# For local UserAPI testing
127.0.0.1 local-api.user.com
127.0.0.1 local-api.mongo.com
With local-api.user.com you'll be able to access the API itself, and with local-api.mongo.com - mongo-express.
Commands to start the whole infra:
cd .k8s
kubectl apply -k .
If you have .Net 5 SDK installed, your can build and run the project on .Net platform. For this, use VisualStudio/Rider or the next CLI commands:
dotnet restore .
dotnet publish src/UserAPI.Host/ -c Release -o out
dotnet out/UserAPI.Host.dll
Please NOTE, that in this case you also need to run MongoDB manually and update the configuration file (appsettings..json) with the right connection string.
This project has E2E tests written with NUnit framework. They are included to CI pipeline. To run them locally you should use docker-compose. Here are the CLI commands you need to run in order to start tests execution:
cd docker-compose
docker-compose -f docker-compose.yaml -f docker-compose-e2e-tests.yaml up --build
After they finished, clean up the local env with:
docker-compose -f docker-compose.yaml -f docker-compose-e2e-tests.yaml down
- Swagger - The web UI for API endpoints calls
- .Net 5.0 - Platform
- Serilog - Used for logging
- MediatR - Used for requests handling
- MongoDB - DB for storing all data
- Kovetskiy Valeriy - Initial work - telegram
This project is licensed under the MIT License - see the LICENSE.md file for details