ApiChassis

ASP.NET CORE WEBAPI Шасси

Этот проект намерен создать базовое шасси ASP.NET Core WebAPI для увеличения задачи разработки API API, перечисленные в MicroServices.io, Specifications, Specification, а также в реализации и дизайне Microsoft. Он создан вокруг Framework .net 5 и готов работать в стеке Docker вместе с такими инструментами, как управление конфигурацией, ведение журнала и кэширование.

Установить и запустить

Установка и запустите последнюю стабильную версию этого шаблона. Просто запустите команды FOLOWENG:

dotnet new install Xopz.Templates.Api
dotnet new apichassis --name MyApi

Выбранные узоры

Вот список уже реализованных шаблонов.

Шаблон	Описание
API Шасси	Этот проект сам по себе предназначен для решения учебных заведений, предложенных в шасси Richardson's Microservices. Выбран сервисного типа проекта API, намеревавшегося для рассмотрения темы 12 фактора VI, VII и VIII.
Метрики API	Этот проект реализует HealthCheck из коробки через app.UseHealthChecks()
API версии	Этот проект реализует версии URL для API
Hateoas	В процессе этого проекта предлагается альтернатива запросить данные по ссылкам, упомянутым в спецификации связывания веб -сайтов и рекомендованной Microsoft.
OAS 3.0	Этот проект следует за третьей версией спецификации OpenAPI для документации API.
ОТДЫХ	Этот API реализует руководство REST по запросу на обработку, он следует за спецификацией HTTP при отправке ответа, а также следует за рекомендациями Microsoft

Требования

Этот шаблон и реализация основаны на .net 5, поэтому он должен иметь .NET SDK или запустить этот проект на изображении .NET Docker

Строить

Создайте образец API

Расширяющие решения будут внутри source папки. Каждое решение должно быть в состоянии открыть в Visual Studio или код для редактирования, компиляции и отладки. Для создания текущего проекта из командной строки используйте команду Follwing:

dotnet build ./source/ApiChassi/ApiChassi.sln

Запустить тестовый набор

Проекты должны быть проведены с помощью базового набора модульных тестов, и они включены в шаблон. Они также могут быть выполнены в одиночестве со следующей командой:

dotnet test ./source/ApiChassi/ApiChassi.sln

Создайте пакет Nuget

Чтобы создать пакет Nuget, мы выбираем для использования изображений Docker. Существуют предопределенные сценарии, которые помогут создать необходимое изображение Docker Nuget Docker и упаковать Nuget в качестве шаблона. Сделать и построить локально (даже на Linux или MacOS):

 # EXECUTE THE FOLLOWING COMMANDS AT THE ROOT FOLDER
# CREATES A DOCKER IMAGE LOCALLY TO PACK THE SOURCE
./.environment/scripts/make_nuget.cmd
# CREATES THE NUPKG
./.environment/script/make_package.cmd

Бегать

Установите пакет Nuget локально

Для локальных тестов можно установить файл nupkg из папки. Для этого выполните следующую команду:

dotnet new --install ./Xopz.Templates.Api.0.0.1.nupkg
# CHECK INSTALLED TEMPLATES
dotnet new --list | grep XOPZ
# CREATE SOLUTION FROM TEMPLATE
dotnet new apichassis --name MyApi

Удалить шаблон

Для удаления установленного шаблона - с nuget.org или локально - использовать:

dotnet new --uninstall Xopz.Templates.Api

Колабатура