MyWebAPITemplate 다운로드 - MyWebAPITemplate 소스 코드 다운로드

MyWebAPITemplate

기타 카테고리

1.0.0

다운로드

내 웹 API 템플릿

ASP.NET 코어를 사용한 모든 종류의 REST API에 대한 스타터 템플릿

이것은 REST API를 구축하기 위해 지속적으로 지속적으로 진행중인 스타터 템플릿입니다.

이 템플릿은 코딩을 시작하고 이미 생각한 프로젝트 구조를 원한다면 매우 간단하고 빠르며 작고 더 큰 프로젝트에서 잘 작동합니다.

세부

기술, 프레임 워크 및 라이브러리

프로그래밍 언어 : C#
프레임 워크 : ASP.NET Core 7 (항상 최신 버전)
데이터베이스 : SQL Server (다른 데이터베이스를 사용할 수도 있음)
ORM : 엔티티 프레임 워크
테스트 : Xunit, MOQ 및 FluentAssertions

건축, 기능 및 패턴

템플릿 폴더 구조

 app                               -> App and related files
 ├─> src                          -> App source
 │   ├─> Web                      -> Entry point for API - runnable project
 │   │   ├─> Controllers          -> API endpoints
 │   │   ├─> Extensions           -> Extension methods
 │   │   ├─> Interfaces           -> Web project's interfaces
 │   │   ├─> Mappers              -> Model mappers
 │   │   ├─> Middlewares          -> Middlewares (e.g. global error handling)
 │   │   |─> Models               -> Models in and out of API
 │   │   ├─> Settings             -> Options pattern for App (e.g. connection strings)
 │   │   ├─> Validators           -> Model validation rules
 │   │   ├── Program.cs           -> START
 │   │   └── Startup.cs           -> START
 │   ├─> Core                     -> Holds business logic
 │   │   ├─> Dtos                 -> Data-transfer-object (used for business logic)
 │   │   ├─> Entities             -> Entity Framework entities for database 
 │   │   ├─> Interfaces           -> Core project's interfaces
 │   │   ├─> Mappers              -> Dto and Entity mappers
 │   │   ├─> Services             -> Business logic services
 │   └─> Infrastructure           -> Data access and external services 
 │       ├─> Database             -> Database access
 │       │   ├─> Configurations   -> Entity Framework table configurations
 │       │   ├─> Migrations       -> Entity Framework autogenerated migrations
 │       │   ├─> Repositories     -> Repository pattern
 │       │   ├── AppDbContext.cs  -> Base context
 │       │   ├── AppSeed.cs       -> Database seeding
 │       │   └── EfRepository.cs  -> Base repository
 │       └─> ExternalServices     -> Services that access external services (e.g. ext. email service)
 └─> tests                        -> App tests
     ├── FunctionalTests          -> Endpoint tests etc.
     │   ├─> Tests                -> All tests
     │   └─> Utils                -> Utility functions (e.g. test database setup)
     ├── IntegrationTests         -> Database tests etc.
     │   ├─> Tests                -> All tests
     │   ├─> Utils                -> Utilities functions (e.g. test database setup)
     ├── UnitTests                -> Application logic tests etc.  
     │   ├─> Tests                -> All tests
     │   ├─> Utils                -> Utility functions 
     └── Shared                   -> Model builders and other shared functions for tests

용법

창에서

최신 .net sdk 다운로드 (https://dotnet.microsoft.com/download)

처음 실행 중 - 데이터베이스 초기화

 dotnet tool install --global dotnet-ef
dotnet ef database update -c ApplicationDbContext -p . /src/Infrastructure/Infrastructure.csproj -s . /src/Web/Web.csproj

시작하다
- 옵션 1. Visual Studio 에서 시작합니다
  1. MyWebAPITemplate.sln 으로 열립니다
  2. F5 누르거나 Debug/Start Debugging
- 옵션 2. CLI 에서 시작
  1. ```
   dotnet run -p . /src/Web/
```
https : // localhost : 5001/swagger/index.html로 이동하십시오

Docker와의 교차 플랫폼 (진행중인)

현재 메모리에서만 가능합니다

새로운 데이터베이스 마이그레이션

새 마이그레이션을 만들어야 할 때 (데이터베이스 스키마를 변경할 때)이 명령을 실행하여 엔티티 프레임 워크에 데이터베이스에 필요한 스키마 변경 사항을 처리하도록 지시하십시오.

 dotnet ef migrations add NewMigrationNameHere --context ApplicationDbContext -p . /src/Infrastructure/Infrastructure.csproj -s . /src/Web/Web.csproj -o Database /Migrations

동기 부여

이 프로젝트는 단일 모 놀리 식 방식으로 API를 구축 할 때 수행 해야하는 모든 정보 흐름을 처리하는 방법으로 시작되었습니다. 기억해야 할 것들이 너무 많고 선택해야 할 많은 선택이 있습니다. 그러므로 나는이 템플릿을 직접 만들었고 실용적인 모든 관행을 저장 했으며이 템플릿이 다른 사람이 한두 가지를 배우는 데 도움이되기를 바랍니다.

이 템플릿에서는 API 건물에 대한 지식을 실용적인 형식으로 수집했습니다. 모범 사례, 인기 및 내 의견이 많은 선호도에 따라 건축 선호도, 도서관 선택 및 기타 선택이 이루어집니다. 이 템플릿의 목적은 확장 가능하고 만족하기 쉬우 며 필요한 구성 및 기타 케이크를 포함하는 ASP.NET를 사용하여 REST API를 구축하는 방법에 대한 좋은 기본 예를 제공하는 것입니다. 이 템플릿은 Microsoft Eshoponweb Reference 응용 프로그램 및 기타 여러 가지에서 영감을 얻었습니다.

목표

유용한 것을 찾을 때마다 템플릿을 개선하기 위해 프로그램의 일부를 처리하는 새로운 더 나은 방법을 생각해냅니다.
이전 프로젝트 중 일부에서 이미 사용한 개념이나 기술 만 사용하므로 그만한 가치가 있는지 알고 있습니다. 이 프로젝트는 모든 실험적인 것들을 땜질하는 것이 아닙니다. 그에 대한 다른 프로젝트가 있습니다 :)
구조를 단순하게 유지하지만 너무 간단하지는 않습니다. 이 프로젝트 구조는 TODO 앱의 경우 약간 과장된 것처럼 보일 수 있지만, 구조는 더 큰 프로젝트에서 코드 구조를 처리하는 한 가지 방법을 보여주기 위해 여기에 있습니다. 코드 구조는 더 많은 양의 코드 및 기능으로 더 큰 시스템을 처리 할 수 있어야합니다.
템플릿을 "모 놀리 식"으로 유지하려면 새로운 프로젝트를 시작하는 가장 좋은 방법이라고 생각하기 때문입니다. 여기에서 자세히 알아보십시오
의견을 말하지만, 나는 더 나은 방법이 있다면 항상 아무것도 바꿀 준비가되어 있다고 생각합니다.