https://github.com/kolappannathan/dotnet-web-api-boilerplate

A boilerplate / starter template for Web API server based on ASP .Net.
https://github.com/kolappannathan/dotnet-web-api-boilerplate

asp-net dot-net dotnet dotnet-starter-template dotnet-webapi github-template starter-project starter-template webapi-starter

Last synced: 29 days ago
JSON representation

A boilerplate / starter template for Web API server based on ASP .Net.

• Host: GitHub
• URL: https://github.com/kolappannathan/dotnet-web-api-boilerplate
• Owner: kolappannathan
• License: mit
• Created: 2018-11-09T06:42:07.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-09-02T01:23:16.000Z (2 months ago)
• Last Synced: 2024-09-29T22:25:13.948Z (about 1 month ago)
• Topics: asp-net, dot-net, dotnet, dotnet-starter-template, dotnet-webapi, github-template, starter-project, starter-template, webapi-starter
• Language: C#
• Homepage:
• Size: 495 KB
• Stars: 27
• Watchers: 3
• Forks: 9
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# .Net Web API boilerplate

[![Generate Repo](https://img.shields.io/badge/Generate%20Repo-Using%20this%20boilerplate-orange?logo=github&style=flat-square)](https://github.com/kolappannathan/dotnet-web-api-boilerplate/generate)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/kolappannathan/dotnet-web-api-boilerplate/CD.yml?branch=main&logo=github&style=flat-square)](https://github.com/kolappannathan/dotnet-web-api-boilerplate/actions?query=workflow%3ACD)

[![GitHub release](https://img.shields.io/github/release/kolappannathan/dotnet-web-api-boilerplate.svg?logo=github&style=flat-square)](https://github.com/kolappannathan/dotnet-web-api-boilerplate/releases)

A boilerplate / template for a WebAPI server based on ASP.Net.

## Scope

This API boilerplate includes the following:

 - Role based JWT authentication.

 - Web API Helper which standardizes responses, maps errors, etc...

 - An implementation of Serilog for logging.

 - A core library with the following

   - Custom data model attributes

   - Database adapter

   - Helper functions for hashing, encrypting, compression, random number & character generation, etc...

 - A constants library for commonly used constants.

## Notice

**Before using the code in production**

###### Change the following values

 - In appsettings.json

    1. Database connection string.

    2. JWT secret, issuer and audience

 - Update the login controller, user lib & auth lib.

 - In program.cs

   1. Update CORS websites list

###### Remove the following

 - Values controller, values lib & corresponding interfaces