Skip to content

dotnet 5 web api with api-versioning, documentation through swagger, localization, claim based jwt token security, feature toggling, centralized logging/exception-handling, throttling, caching, etc.

License

Notifications You must be signed in to change notification settings

dotnetcore5/Dotnet.Sample.Api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

82 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dotnet.Sample.Api GitHub release GitHub Release Date Maintenance

Centralized Logging GitHub repo size in bytes GitHub top language Lines of code Codacy Badge
Localization Api Versioning Claim-based-token Feature Toggling Maintainability
Central Logging Swagger Support Visual Studio 2019 .Net Framework GitHub language count

swagger documentation

Repository codebase

The repository consists of projects as below:

# Project Name Project detail location Environment
1 Dotnet.Sample.Api Dotnet5 WebApi as backend src\Api folder .Net Framework
2 Dotnet.Sample.Api.Tests Tests for webapi src\Api.Test folder .Net Framework

Application Folder structure


application folder structure


Summary

The overall objective of the applications :

Through the login endpoint A user can Login and jwt authentication is used.

Once authorized, user can do "CRUD" operation on the products endpoint

Setup detail

Environment Setup detail

Download/install

  1. .Net Framework to run webapi project

  2. VS2019 to run/debug the applications Or VSCode to run/debug the applications

Project Setup detail
  1. Please clone or download the repository from github

  2. Create a folder and place the downloaded repository and unzip if downloaded.

  3. Open the solution file through Visual Studio 2019 or through Visual Studio Code open the newly created folder where the repository is downloaded

(a) To start the webapi
  1. Through Visual Studio 2019, click F5 button to run the webapi, Please make sure the webapi project is selected as startup project.

  2. Or through Visual Studio Code, open a command terminal by pressing the computer keyboard buttons Control and ~

    (a) Within the terminal, browse to folder location named as "src\Api"

    (b) Restore the dependencies, type dotnet restore on the terminal

    (c) Run the webapi project, type dotnet run on the terminal

  3. WebApi shall start running on port 5000

For better experience please use chrome browser
(b) To run the unit test project
  1. Through Visual Studio 2019, open the Test Explorer and run the tests.

  2. Or through Visual Studio Code Open a new command terminal

    (a) Within the new terminal, browse to the folder named as "src\Api.Test"

    (b) To run the tests, type dotnet test on the terminal


To-do:

caching

endpoint throttling/rate limit


Visitor Badge GitHub contributors license

Flag Counter