Skip to content

DocumentProcessingAPI is a part of my portfolio. It is ASP.NET Core 6 Minimal API responsible for processing csv files.

Notifications You must be signed in to change notification settings

Emilkens/DocumentProcessingAPI

Repository files navigation

DocumentProcessingAPI 📁

This project is a part of my C#, ASP.NET portfolio. It is based on a recruitment task that was once assigned to me.

Overview of the API

This is ASP.NET Core 6 Minimal API project responsible for processing csv files and returning them as JSON along with file metadata.

Authentication

API user must authenticate using Basic Auth. Authentication is handled by aprropriate middleware. This was one of the task's requirements. The expected credentials can be configured by setting the following environment variables:

  • DOCUMENT_PROCESSING_API_PASSWORD
  • DOCUMENT_PROCESSING_API_LOGIN

How to test it

By default API will expose its actions on https://localhost:7200. In order to authenticate, an HTTP request must contain an appropriate authentication header (refer to HTTP Authentication).

API expects request's body to contain specific csv text. Example files are located in /Postman/TestFiles/ directory.

Recommended approach - Postman

It is recommended to use Postman API Platform to test the app. Repository contains ready-to-use HTTP requests covering different scenarios. These are exported to postman_collection.json. In order to use them, /Postman/TestFiles/ folder has to be moved to Postman's working directory.

About

DocumentProcessingAPI is a part of my portfolio. It is ASP.NET Core 6 Minimal API responsible for processing csv files.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages