aspnetcore-webapi-template - GitLite

KO | EN

gitlite — search

#javascript #python #react #ai #typescript #go #golang #android #rust #deep-learning #kubernetes #security #ios #openai

aspnetcore-webapi-template

(★ 194)

This project is an Web API Open-Source Boilerplate Template that includes NET 8, Web API standards, clean n-tier architecture, GraphQL service, Redis, Mssql, Mongo databases and User Auditing (Identity) with a lot of best practices.

파일 탐색기

최종 버전 다운로드 (.zip)

- - dotnet-core.yml
- - template.json
- .dockerignore
- docker-compose.yml
- Template.WebApi.sln
.gitattributes
.gitignore
LICENSE
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/sinantok/aspnetcore-webapi-template

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd aspnetcore-webapi-template

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.

docker compose -f src/docker-compose.yml up -d --build

compose 설정 파일에 정의된 서비스들을 대상으로 명령을 실행합니다.

✅ 터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

3. .NET

보통

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
.NET SDK dotnet 명령어를 쓰기 위한 SDK입니다.

⚠️ 이 프로젝트는 규모가 큰 저장소라, 이 방법이 실제 핵심 제품이 아니라 내부 하위 패키지를 가리키는 것일 수 있습니다. README 전체를 함께 확인해보세요.

cd src/Libraries/Caching

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

dotnet restore

프로젝트에 필요한 패키지를 내려받습니다.

dotnet run

프로젝트를 빌드하고 바로 실행합니다.

✅ dotnet run 실행 후 터미널에 나타나는 안내 메시지나 주소를 확인하세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ASP.NET Core Web Api Template
 
This project is an Web API Open-Source Boilerplate Template that includes Net 8, Web API standards, clean n-tier architecture, GraphQL service, Redis, Mssql, Mongo databases and User Auditing (Identity) with a lot of best practices.

## Releases
v1.0, v2.0, v3.0, v4.0

## v4.0

Follow these steps to get started with this Boilerplate Template.

### Download the Extension
Make sure Visual Studio 2019 is installed on your machine with the latest SDK.
[Download from Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=SinanTok.ASPNETCoreWebAPI). Install it on your machine.

Follow these Steps to get started.

![enter image description here](https://i.hizliresim.com/HCtEh0.png)

You Solution Template is Ready!

![enter image description here](https://i.hizliresim.com/o9t66ud.PNG)

### Alternatively you can also clone the [Repository](https://github.com/sinantok/aspnetcore-webapi-template).

1. Clone this Repository and Extract it to a Folder.
3. Change the Connection Strings for the "DefaultConnection" and "IdentityConnection" in the appsettings.json
2. Run the following commands on Powershell in the Projecct's Directory.
- dotnet restore
- dotnet ef database update -Context IdentityContext
- dotnet ef database update -Context ApplicationDbContext
- dotnet run (OR) Run the Solution using Visual Studio

### Swagger
You can view endpoints with swagger
![enter image description here](https://i.hizliresim.com/3jyeib7.PNG)

### HealthCheck
You can check the status of the services with HealthCheck

### Default Roles & Credentials
As soon you build and run your application, default users and roles get added to the database.

Default Roles:
- SuperAdmin
- Admin
- Moderator
- Basic

Here are the credentials for the default user.
- Email - superadmin@gmail.com  / Password - 123Pa$$word!

You can use these default credentials to generate valid JWTokens at the ../api/account/authenticate endpoint.

## Technologies
- .Net 8 WebApi
- .NET 8
- REST Standards
- GraphQL
- MSSQL
- MongoDB
- Microsoft Identity
- Redis
- SeriLog(seq)
- AutoMapper
- Smtp / Mailkit
- Swagger Open Api
- Health Checks

## Features
- [x] Net 8
- [x] N-Tier Architecture
- [x] Restful
- [x] GraphQl
- [x] Entity Framework Core - Code First
- [x] Repository Pattern - Generic
- [x] UnitOfWork
- [x] Redis Caching
- [x] Response Wrappers
- [x] Microsoft Identity with JWT Authentication
- [x] Role based Authorization
- [x] Identity Seeding
- [x] Database Seeding
- [x] Custom Exception Handling Middlewares
- [x] Serilog
- [x] Automapper
- [x] Swagger UI
- [x] Healthchecks
- [x] SMTP / Mailkit / Sendgrid Email Service
- [x] Complete User Management Module (Register / Generate Token / Forgot Password / Confirmation Mail)
- [x] User Auditing
- [ ] Pagination
- [ ] Refit
- [ ] Fluent Validation
- [ ] Unit Test
- [x] .Net 8 migration
- [x] MongoDb Operations
- [x] Docker Support `docker-compose.yml` and `Dockerfile`

## Purpose of this Project

This template project has been developed to ensure that the necessary structures are not installed over and over again when creating each new WebAPI project. In addition, the structures that should be in a WepAPI are developed with a clean architecture and up-to-date technologies.

## Prerequisites
- Visual Studio 2019 Community and above
- .NET 8 SDK and above
- Basic Understanding of Architectures and Clean Code Principles

## Give a Star ⭐️
If you found this Implementation helpful or used it in your Projects, do give it a star. Thanks!

## Licensing

sinantok/aspnetcore-webapi-template Project is licensed with the [MIT License](https://github.com/sinantok/aspnetcore-webapi-template/blob/master/LICENSE).

## About the Author
### Sinan Tok
- Github [github.com/sinantok](https://github.com/sinantok)
- Linkedin - [Sinan Tok](https://www.linkedin.com/in/sinantok/)