Краткое руководство по созданию веб-API с использованием ядра dot net.
API — это аббревиатура от Application Programming Interface, промежуточного программного обеспечения, которое позволяет двум приложениям взаимодействовать друг с другом для обмена данными или выполнения какой-либо операции. В современном мире большинство приложений основано на микросервисной архитектуре, а не на монолитной (если только ваше приложение не маленькое), и способ реализации заключается в том, чтобы различные службы открывали себя другим приложениям с помощью API. В этом пошаговом руководстве мы настроим инструменты и создадим простой API с использованием dot net core.
Предпосылки
Установите указанные выше необходимые зависимости и приготовьтесь к настройке кода vs.
Настройка кода VS
Следующим шагом будет установка необходимого расширения для кода Visual Studio. Чтобы установить расширение, нажмите Ctrl+Shift+x в коде vs и найдите нужные расширения, чтобы загрузить их. Вот список расширений для установки:
- Основные инструменты .Net
- C#
- SQL-сервер (mssql)
Вы можете установить другое расширение, полезное для кодирования:
- Visual Studio Intellicode — разработка с помощью ИИ
- Visual Studio Keymap — сопоставление клавиш Visual Studio
Что дальше ?
После настройки кода vs давайте углубимся в процесс создания API. Поскольку мы загрузили SDK dot net core, очевидно, что он поставляется с комплектом для разработки, а также с командными строками. Итак, чтобы создать первый ASP.NET Core API, перейдите в определенную папку, откройте терминал и выполните следующие действия:
dotnet new
Это отобразит список приложений, которые могут использовать предложения net core. Теперь, чтобы создать проект, выполните -
dotnet new webapi -o <ApplicationName>
В папке, которую вы видите, проект шаблона создан, как показано. Мы вернемся к структуре приложения позже.
Подождите, это все?
Ага!! так что в основном вы только что создали API. Чтобы запустить приложение, вам просто нужно нажать F5, это создаст и запустит приложение в порту локального сервера. Откройте localhost, вы увидите панель API swagger.
Вы можете видеть, что проект шаблона уже поставляется как API /WeatherForecast. Просто нажмите Попробовать и выполните /WeatherForecast, чтобы увидеть ответ, или вы можете напрямую перейти на https://localhost:5001/WeatherForecast. Здесь следует отметить, что запрос и ответ представлены в формате Json, который является собственностью REST API.
Код
Разберем структуру шаблона Project. Здесь нужно сосредоточиться на нескольких файлах.
appsettings.json — этот файл Json будет содержать все необходимые параметры конфигурации. Он используется для хранения строк подключения к базе данных, любых глобальных переменных области приложения и т. д.
Program.cs — это файл, который выполняется при запуске приложения. Обычно называется точкой входа приложения. Этот файл будет отвечать за то, что мы говорим о настройке хостинга и выполнении файла startup.cs.
Startup.cs — это файл, в котором вам понравится писать код, когда вы ознакомитесь с основной концепцией dotnet. Этот файл отвечает за две вещи: регистрацию сервисов (Injecting service) и, во-вторых, настройку промежуточных продуктов. Я знаю, что эти термины немного скучны, но это то место, где приложение начинает вести себя.
Контроллер — в этой папке вы можете создавать свои контроллеры. так что это за контроллеры? это классы, которые используются для определения и установки действия, которое будет вызываться при вызове определенного API. Вы можете взглянуть на контроллер WeatherForecastController.cs, реализующий контроллер с помощью метода Get().
Краткое содержание
Вот как вы можете сделать простой API для отдыха. Пока что мы узнали, как создать веб-API с использованием шаблона и запустить его, о файлах и структуре проекта. Следующая статья будет основана на реализации реальной идеи, такой как трекер расходов, и представит базу данных как часть серверной части и реализует несколько шаблонов проектирования как часть низкоуровневого дизайна приложения.
А пока, увидимся! 🦏
