MyWebAPITemplate Скачать - MyWebAPITemplate исходный код скачать

MyWebAPITemplate

Другие категории

1.0.0

Скачать

Мой шаблон веб -API

Шаблон стартера для всех видов API REST с ядром ASP.NET

Это моя самоуверенная, постоянно работающая в процессе работы, шаблон стартера, для создания API REST.

Этот шаблон для вас, если вы просто хотите начать с кодирования, хотите уже продуманную структуру проекта, это довольно просто и быстро учиться, и работает над более мелкими и большими проектами.

Подробности

Технологии, рамки и библиотеки

Язык программирования: C#
Framework: ASP.NET CORE 7 (всегда последняя версия)
База данных: SQL Server (также возможно использовать другие базы данных)
ORM: Организация сущности
Тестирование: XUNIT, MOQ & FluentArsertions

Архитектура, функции и узоры

Шаблонная структура папки

 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

Кроссплатформенное с докером (в процессе)

В настоящее время возможно только с помощью в памяти

Новые миграции базы данных

Когда вам необходимо создать новую миграцию (при изменении схемы базы данных), затем запустите эту команду, чтобы сообщить Entity Framework для обработки необходимых изменений схемы для базы данных.

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

Мотивация

Этот проект начался как мой способ справиться с информационным потоком всего, что нужно сделать при создании API с одним монолитным образом. Есть так много вещей, чтобы помнить, и есть огромное количество вариантов, которые нужно сделать. Поэтому я сделал этот шаблон для себя, чтобы хранить все практики, которые я нашел практичным, и я надеюсь, что этот шаблон также может помочь кому -то другому выучить что -то или две.

В этом шаблоне я собрал свои знания о построении API в практическом формате. Архитектурные предпочтения, выбор библиотеки и другие варианты сделаны, основанные на лучших практиках, популярности и моих собственных самоуверенных предпочтениях. Цель этого шаблона состоит в том, чтобы дать хороший базовый пример того, как построить API REST с помощью ASP.NET, которые являются масштабируемыми, простыми в мантере и содержат необходимые конфигурации и другие вкусности. Этот шаблон вдохновлен справочным приложением Microsoft Eshoponweb и многими другими.

Цели

Чтобы улучшить шаблон каждый раз, когда я нахожу что -то полезное, или я придумываю новый лучший способ справиться с какой -то частью программы.
Чтобы использовать только концепции или технологии, которые я уже использовал в некоторых из моих предыдущих проектов, поэтому я знаю, стоит ли это того. Этот проект не для того, чтобы возиться со всеми экспериментальными вещами, есть другие проекты для этого :)
Чтобы структура была простой, но не слишком простой. Эта структура проекта может показаться немного чрезмерной для приложения Todo, но структура здесь, чтобы показать один способ обработки структуры кода в более крупных проектах. Структура кода должна иметь возможность обрабатывать более крупные системы с большим количеством кода и функций.
Чтобы шаблон как «монолитный», потому что я думаю, что это может быть лучший способ начать новый проект. Прочитайте больше здесь
Быть самоуверенным, но я всегда думаю, что готов к что -либо изменить, если есть лучший способ сделать