Создайте простой API с помощью ASP.NET CORE 🔥

Здравствуйте люди, это мой первый блог на платформе, надеюсь, вы найдете эту статью полезной ⭐.

Предположим, нам нужно создать API, и он должен быть на ASP.NET Core. Что нам делать? 🤔

Во-первых, для работы с платформой .NET вам необходимо установить один из ее SDK и соответствующую среду исполнения, я рекомендую вам иметь самые последние версии, нажмите здесь, чтобы посмотреть SDK 👈.

Этот SDK поставляется с CLI (интерфейс командной строки), который позволяет нам создавать и запускать наш проект, а также многое другое!

Теперь мы можем создать проект в терминале с помощью следующей команды

dotnet new webapi -n "YourProjectName"
Войдите в полноэкранный режим Выход из полноэкранного режима

Эта команда специфична для создания API, но вы можете увидеть все различные варианты проекта, доступные с помощью этой команды:

dotnet new --list
Войдите в полноэкранный режим Выход из полноэкранного режима

После этого мы увидим, что команда, которую мы ранее выполнили, создала каталог с указанным именем:

Теперь вы можете выбрать редактор кода по своему вкусу 😊.
По умолчанию я буду использовать Visual Studio Code, открою редактор и перейду в только что созданную папку:

Как мы видим, он создал набор файлов, непосредственно готовых к выполнению 🔥.

Чтобы проверить, что все идет хорошо, (внутри каталога проекта) выполните в терминале следующую команду:

dotnet watch run
Войдите в полноэкранный режим Выход из полноэкранного режима

Теперь, когда у нас есть готовый проект
Если все прошло успешно, то в браузере должен появиться следующий интерфейс:

Это Swagger, и это просто графический интерфейс, который поможет нам протестировать наш API, он поставляется по умолчанию при создании проекта webapi. 👌

Вы видите, что у него уже есть конечная точка, потому что шаблон поставляется с ней по умолчанию, и из Swagger вы можете проверить его работу, разверните панель, нажмите Try и запустите. ❤️

⭐ Теперь, когда у нас все готово к работе, я покажу вам, как создать ваш контроллер и, соответственно, создать ваши конечные точки! ⭐

Вы должны создать .cs файл в папке Controllers, это будет контроллер и должен соответствовать следующей номенклатуре по соглашению: NameController.
Например, если мне нужен контроллер для моих сотрудников, я создам контроллер EmployeeController 👻

Внутри файла создайте класс с тем же именем и расширьте его до класса ControllerBase, как показано в следующем примере (не забудьте добавить пространство имен ControllerBase):

using Microsoft.AspNetCore.Mvc;

namespace YourProjectName.Controllers
{
    public class EmpleadoController : ControllerBase
    {

    }
}
Войдите в полноэкранный режим Выход из полноэкранного режима

Этот класс должен быть связан с парой атрибутов:

[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
Войдите в полноэкранный режим Выход из полноэкранного режима

Во втором атрибуте, Route, мы указываем способ доступа к конечным точкам, который обычно является именем контроллера, мы будем обращаться к конечной точке этими возможными способами:

Empleado/get
Empleado/post
Empleado/put
Войдите в полноэкранный режим Выход из полноэкранного режима

Теперь к главному, конечными точками будут методы этого 😲 класса.

мы попробуем следующий метод:

[HttpGet("{i}")]
public int Get(int i)
{
   return i + 1;
}
Войдите в полноэкранный режим Выход из полноэкранного режима

Теперь мы можем снова запустить приложение и увидим, что метод появился в Swagger, так что вы можете протестировать его из этого интерфейса.

Как видно из кода, это простой метод, который получает число и возвращает число +1. 🤣

Но важно то, что мы связываем его с атрибутом.
Этот атрибут определяет метод http для доступа к нашему методу.

Посмотрите различные методы http, чтобы получить представление 🔥.

Также обратите внимание, что в качестве аргумента мы передаем строку со значением в квадратных скобках.
значение в квадратных скобках, это значение мы получим через Query String. В этой строке вы можете указать, как получить доступ к методу. Наблюдать 👀

[HttpGet("sumar/{i}")]
public int Get(int i)
{
    return i + 1;
}
Войдите в полноэкранный режим Выход из полноэкранного режима

Теперь вы знаете супер-основы для начала создания API. Вскоре я изучу больше тем, чтобы дополнить более сложные вещи, такие как базы данных, документация и т.д.

Хорошего дня. 🔥👌

Оцените статью
devanswers.ru
Добавить комментарий