В этой статье мы рассмотрим, как создать проект веб-API ASP.NET Core с помощью интерфейса командной строки .NET Core (CLI). Кроме того, мы расскажем, как собрать, запустить и протестировать проект API, используя Swagger и браузер. Эта статья рассчитана на новичков в ASP.NET Core, так что это руководство поможет вам сделать первые шаги для начала работы.
Способы создания проекта веб-API ASP.NET Core
Существует два основных способа создания проекта веб-API ASP.NET Core:
- С помощью .NET Core CLI
- С помощью Visual Studio
В этом руководстве мы рассмотрим создание с помощью .NET Core CLI.
Шаг 1: Устанавливаем расположение директории
Перед созданием нового проекта веб-API ASP.NET Core необходимо выбрать папку, в которой вы хотите сохранить свой проект.
В этом примере мы создадим наш проект в папке N:\Projects.
Подготовка: Откройте командную строку в режиме администратора и перейдите в нужный каталог с помощью команды cd и создайте каталог под проект.
Шаг 2: Просмотр доступных шаблонов проектов
Чтобы создать проект веб-API, давайте изучим доступные шаблоны проектов с помощью .NET Core CLI.
Выполните следующую команду:
dotnet new list
Это отобразит список доступных шаблонов. Найдите шаблон ASP.NET Core Web API, который обычно обозначается коротким именем webapi.
Как видно на изображении выше, предоставляется один шаблон с названием ASP.NET Core Web API, и для создания такого проекта можно использовать команду webapi (короткое имя шаблона). Языком программирования по умолчанию для этого проекта веб-API является C#, но можно также использовать язык F#.
Шаг 3: Создание проекта веб-API ASP.NET Core
Вы можете создать проект веб-API двумя способами:
Без назначения наименования:
dotnet new webapi
Тогда в папке создастся проект с наименованием по умолчанию.
С конкретным наименованием:
dotnet new webapi --name MyFirstWebAPIProject
В данном случае создастся проект с названием MyFirstWebAPIProject.
Шаг 4: Изучение структуры проекта
После создания проекта перейдите в созданную директорию:
cd название_проекта
Вы увидите несколько файлов проекта по умолчанию, включая:
- Controllers/WeatherForecastController.cs
- Program.cs
- appsettings.json
Эти файлы предоставляются шаблоном веб-API для быстрого запуска вашего проекта.
Шаг 5: Открытие проекта в Visual Studio Code
Чтобы работать с проектом, откройте его в Visual Studio Code:
- Убедитесь, что установлен Visual Studio Code.
- Измените каталог в командной строке на каталог проекта (cd MyFirstWebAPIProject)
Затем, чтобы открыть файлы и папки проекта в Visual Studio Code, введите code . (code пробел точка) и нажмите клавишу Enter, как показано ниже.
Шаг 6: Сборка проекта веб-API ASP.NET Core
После настройки проекта давайте соберем его.
Вы можете собрать проект двумя способами:
Способ 1: Использование терминала Visual Studio Code
- Откройте терминал внутри Visual Studio Code.
Сначала откройте новый терминал в Visual Studio Code. Для этого нажмите на меню "Terminal" и выберите пункт "New Terminal" в меню Visual Studio Code, как показано на изображении ниже.
После того, как вы нажмете на пункт "New Terminal", откроется окно терминала, как показано на изображении ниже. В терминале введите dotnet build и нажмите клавишу Enter, как показано на изображении ниже. Эта команда используется для сборки существующего проекта. После того, как вы введете dotnet build и нажмете Enter, проект будет собран, и вы получите следующее сообщение.
Способ 2: Использование командной строки
В командной строке сначала установите каталог на папку вашего проекта, затем введите dotnet build и нажмите клавишу Enter, как показано на изображении ниже.
Шаг 7: Запуск проекта веб-API ASP.NET Core
Далее давайте запустим проект, чтобы запустить веб-API.
Способ 1: Использование терминала Visual Studio Code
В окне терминала выполните следующую команду:
После того, как вы введете dotnet run и нажмете Enter, вы получите следующее сообщение.
Способ 2: Использование командной строки
В командной строке сначала установите каталог на папку вашего проекта, затем введите команду dotnet run и нажмите клавишу Enter, как показано на изображении ниже. Но перед выполнением следующей команды, пожалуйста, закройте терминал Visual Studio, где мы уже запустили приложение, иначе вы получите ошибку. (Ошибка возникает из-за конфликта портов, поскольку приложение уже запущено в терминале VS Code).
Шаг 8: Тестирование веб-API с помощью Swagger
Проекты веб-API ASP.NET Core поставляются с предустановленным Swagger. Swagger предоставляет интерактивный интерфейс для тестирования API. Чтобы получить к нему доступ:
1. Откройте браузер и введите URL, на котором работает приложение(например, http://localhost:5187)
2. Добавьте к нему /swagger. (вот так http://localhost:5187/swagger)
Swagger отобразит информацию о всех доступных методах в контроллерах. По умолчанию у нас есть /WeatherForecast, и его метод — GET. Теперь нажмите на /WeatherForecast, чтобы увидеть подробности.
Примечание: Swagger также является клиентским инструментом для работы с API, и с помощью Swagger мы также можем тестировать веб-API. Если вы используете проект веб-API ASP.NET Core, то Swagger установлен в проект по умолчанию.
Тестирование веб-API ASP.NET Core с помощью Swagger:
Теперь давайте посмотрим, как протестировать API, то есть WeatherForecast API, с помощью Swagger. Чтобы протестировать API с помощью Swagger, нажмите кнопку "Try it out", как показано на изображении ниже.
После того, как вы нажмете кнопку "Try it out", откроется область ниже, и здесь нажмите кнопку "Execute", как показано на изображении ниже.
После того, как вы нажмете кнопку "Execute", вы получите ответ, как показано на изображении ниже. Здесь вы можете найти URL запроса, тело ответа, код состояния ответа и заголовки ответа.
Заключение
Поздравляем! Вы успешно создали проект веб-API ASP.NET Core с помощью .NET Core CLI. Вы также узнали, как собрать, запустить и протестировать свой API с помощью Swagger.
Если вам интересна разработка на python, то можете перейти на канал моего коллеги.