Clean Architecture Web API

This application is a RESTful web service designed to securely process uploaded files using an API key-based security mechanism.

Additionally, it includes an example of generating a basic report for all uploaded files.

The application also demonstrates how to fetch data from an entity using Entity Framework Core, along with effective LINQ queries.

The codebase adheres to Clean Architecture principles, ensuring improved code quality and maintainability.

Table of Contents

• Features
• Prerequisites
• Getting Started
• Building the Docker Image
• Running the Application
• API Endpoints
• Endpoints Usage

Features

• Runs on ASP.NET Core (.NET 8)
• Containerized with Docker
• API Key-based Security Mechanism Implementation
• Uses Entity Framework Core

Prerequisites

Before you begin, ensure you have the following installed:

• .NET SDK 8.0
• Docker Desktop
• Postman (for testing API endpoints)
• SSMS
• SQL Server Express

Getting Started

Let's get start by cloning the repository.

git clone https://github.com/steven-repositories/Clean.Architecture.API.git
cd Clean.Architecture.API

After cloning the repository, open your SSMS and login into you local server. Usually named as: "localhost".

Create a database; you decide what the database name is.

After creating a database, you also need to create a login user under the Security > Logins.

Right click the Logins folder and select New Login; you decide what would be the credentials for this login user.

In the codebase, go to the appsettings.json and change the value of "DatabaseName", "User Id", and "Password" for the "CC" connection string based on the database name and credentials you created.

You need to change the "Server" as well in "CC" connection string based on what is your IPv4 Address. Open your command prompt and execute "ipconfig" command to see what is your IP Address.

Building the Docker Image

Before building the docker image, you need to run your Docker Desktop in your local machine. Make sure that the docker engine is running.

To build an image, you need to execute the "docker build" command with option of using tag "-t" alongside with the name of the image you want to build.

docker build -t {image_name}:{tag} -f {Dockerfile path} --progress=plain .

So when you are going to build your Docker Image with this application, the command you need to execute should be like this:

docker build -t clean_architecture_api:1.0 -f ./Dockerfile --progress=plain .

Running the Application

Once the Docker Image is created, you can run the application inside a container by executing the "docker run" command.

You can set your desired host port and the container port when you execute the "docker run" command.

docker run -p {host_port}:{container_port} {image_name_here}

Based on what is in the Dockerfile, the application will be exposed to port 8080. So the command you need to execute to run the application in Docker should be like this:

docker run -p 8080:8080 Clean.Architecture.API:1.0

API Endpoints

The endpoints that this application have are:

1. api/auth/key

   • Uses for generating new API Key to be set as header for other API Key-based security implemented endpoints.

2. api/file/upload/persons

   • Uses to securely upload a JSON file with "persons" in it.
   • You can download this sample JSON file that can be use for file uploading.

3. api/person/{team}/max-score

   • Uses to get the highest score that a single team have in the database.

4. api/person/{team}/second-to-least-score

   • Uses to get the second to least score that a single team have in the database.

5. api/person/{team}/union-names

   • Uses to unionized by comma separated all the person names for a single team.

6. api/report/files

   • Uses to generate basic report for all the files that have been processed or saved in the database.

You can import this collection to your Postman using the following API link: https://api.postman.com/collections/4784032-c01a7b96-7947-4143-92d8-c759f70b87f7?access_key={ACCESS_KEY}

Contact the repository owner to get the access key.

Or you can create your own Postman collection.

Endpoints Usage

All of the endpoints that is except for the generating new API key (api/auth/key) are required to pass a header key named "Auth-Key". The value for this "Auth-Key" header can be retrieved by executing the api/auth/key endpoint.

This is because the endpoints does have a security implementation where it validates if the requested endpoint does have an "Auth-Key" header before it proceed to the functionality of the action method. You can find the code in AuthenticationMiddleware.cs.

For example (in procedure):

1. Execute the "api/auth/key" endpoint

   • This will return an "access_key" field in the response body.

2. Let's say you're going to execute "api/file/upload/persons" endpoint. Before executing the endpoint, add first "Auth-Key" header in the request with a value that is from "access_key" of #1 response.

   • This will return a response body that containts "success" and "data" fields indicating if it is a success or not and a message inside the data field.