Publikowanie internetowego interfejsu API platformy ASP.NET Core w usłudze Azure API Management za pomocą programu Visual Studio

Artykuł
11/30/2023

Z tego samouczka dowiesz się, jak utworzyć projekt internetowego interfejsu API platformy ASP.NET Core przy użyciu programu Visual Studio, upewnić się, że ma on obsługę interfejsu OpenAPI, a następnie opublikować internetowy interfejs API zarówno w usłudze aplikacja systemu Azure, jak i w usłudze Azure API Management.

Ustawienia

Do ukończenia samouczka potrzebne jest konto platformy Azure.

Otwórz bezpłatne konto platformy Azure, jeśli go nie masz.

Tworzenie internetowego interfejsu API platformy ASP.NET Core

Program Visual Studio umożliwia łatwe tworzenie nowego projektu internetowego interfejsu API platformy ASP.NET Core na podstawie szablonu. Postępuj zgodnie z poniższymi instrukcjami, aby utworzyć nowy projekt internetowego interfejsu API platformy ASP.NET Core:

W menu Plik wybierz pozycję Nowy>projekt.
Wprowadź internetowy interfejs API w polu wyszukiwania.
Wybierz szablon internetowego interfejsu API platformy ASP.NET Core i wybierz pozycję Dalej.
W oknie dialogowym Konfigurowanie nowego projektu nadaj projektowi nazwę WeatherAPI i wybierz pozycję Dalej.
W oknie dialogowym Dodatkowe informacje:
Upewnij się, że platforma .NET 6.0 (obsługa długoterminowa).
Upewnij się, że pole wyboru Użyj kontrolerów (usuń zaznaczenie, aby używać minimalnych interfejsów API) jest zaznaczone.
Upewnij się, że zaznaczono pole wyboru Włącz obsługę interfejsu OpenAPI.
Wybierz pozycję Utwórz.

Eksplorowanie kodu

Definicje struktury Swagger umożliwiają usłudze Azure API Management odczytywanie definicji interfejsu API aplikacji. Zaznaczając pole wyboru Włącz obsługę interfejsu OpenAPI podczas tworzenia aplikacji, program Visual Studio automatycznie dodaje kod w celu utworzenia definicji struktury Swagger. Program.cs Otwórz plik, który pokazuje następujący kod:


...

builder.Services.AddSwaggerGen();

...

if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI(); // Protected by if (env.IsDevelopment())
}

...

Upewnij się, że definicje struktury Swagger są zawsze generowane

Usługa Azure API Management wymaga, aby definicje struktury Swagger zawsze obecne, niezależnie od środowiska aplikacji. Aby upewnić się, że są one zawsze generowane, przejdź app.UseSwagger(); poza if (app.Environment.IsDevelopment()) blok.

Zaktualizowany kod:


...

app.UseSwagger();

if (app.Environment.IsDevelopment())
{
    app.UseSwaggerUI();
}

...

Zmienianie routingu interfejsu API

Zmień strukturę adresu URL wymaganą Get do uzyskania dostępu do akcji .WeatherForecastController Zakończ poniższe kroki:

Otwórz plik WeatherForecastController.cs.
Zastąp [Route("[controller]")] atrybut na poziomie klasy atrybutem [Route("/")]. Zaktualizowana definicja klasy :
```
[ApiController]
[Route("/")]
public class WeatherForecastController : ControllerBase
```

Publikowanie internetowego interfejsu API w usłudze aplikacja systemu Azure

Wykonaj następujące kroki, aby opublikować internetowy interfejs API platformy ASP.NET Core w usłudze Azure API Management:

Publikowanie aplikacji interfejsu API w usłudze aplikacja systemu Azure Service.
Opublikuj aplikację internetowego interfejsu API platformy ASP.NET Core w wystąpieniu usługi Azure API Management.

Publikowanie aplikacji interfejsu API w usłudze aplikacja systemu Azure

Wykonaj następujące kroki, aby opublikować internetowy interfejs API platformy ASP.NET Core w usłudze Azure API Management:

W Eksploratorze rozwiązań kliknij prawym przyciskiem myszy projekt i wybierz polecenie Opublikuj.
W oknie dialogowym Publikowanie wybierz pozycję Azure i wybierz przycisk Dalej.
Wybierz pozycję aplikacja systemu Azure Service (Windows) i wybierz przycisk Next (Dalej).
Wybierz pozycję Utwórz nową usługę aplikacja systemu Azure.

Zostanie wyświetlone okno dialogowe Tworzenie usługi App Service . Pola wprowadzania Nazwa aplikacji, Grupa zasobów i Plan usługi App Service są wypełniane. Możesz zachować te nazwy lub zmienić je.
Zaznacz przycisk Utwórz.
Po utworzeniu usługi App Service wybierz przycisk Dalej .
Wybierz pozycję Utwórz nową usługę API Management.

Zostanie wyświetlone okno dialogowe Tworzenie usługi API Management. Możesz pozostawić pola pozycji Nazwa interfejsu API, Nazwa subskrypcji i Grupa zasobów, tak jak są. Wybierz nowy przycisk obok wpisu usługa API Management i wprowadź wymagane pola z tego okna dialogowego.

Wybierz przycisk OK, aby utworzyć usługę API Management.
Wybierz przycisk Utwórz, aby kontynuować tworzenie usługi API Management. Wykonanie tego kroku może potrwać kilka minut.
Po zakończeniu wybierz przycisk Zakończ .
Zostanie zamknięte okno dialogowe i zostanie wyświetlony ekran podsumowania zawierający informacje o publikowaniu. Wybierz przycisk Publikuj.

Internetowy interfejs API jest publikowany zarówno w usłudze aplikacja systemu Azure, jak i w usłudze Azure API Management. Zostanie wyświetlone nowe okno przeglądarki i zostanie wyświetlone interfejs API uruchomiony w usłudze aplikacja systemu Azure Service. Możesz zamknąć to okno.
Otwórz witrynę Azure Portal w przeglądarce internetowej i przejdź do utworzonego wystąpienia usługi API Management.
Wybierz opcję Interfejsy API z menu po lewej stronie.
Wybierz interfejs API utworzony w poprzednich krokach. Jest on teraz wypełniany i można go eksplorować.

Konfigurowanie opublikowanej nazwy interfejsu API

Zwróć uwagę, że nazwa interfejsu API nosi nazwę WeatherAPI. Chcemy jednak nazwać ją Prognozami pogody. Wykonaj następujące kroki, aby zaktualizować nazwę:

Dodaj następujące polecenie bezpośrednio Program.cs po servies.AddSwaggerGen();

builder.Services.ConfigureSwaggerGen(setup =>
{
    setup.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo
    {
        Title = "Weather Forecasts",
        Version = "v1"
    });
});

Ponownie opublikuj internetowy interfejs API platformy ASP.NET Core i otwórz wystąpienie usługi Azure API Management w witrynie Azure Portal.
Odśwież stronę w przeglądarce. Zobaczysz, że nazwa interfejsu API jest teraz poprawna.

Sprawdzanie, czy internetowy interfejs API działa

Możesz przetestować wdrożony internetowy interfejs API platformy ASP.NET Core w usłudze Azure API Management w witrynie Azure Portal, wykonując następujące czynności:

Otwórz kartę Test.
Wybierz / lub operację Pobierz .
Wybierz Wyślij.

Czyszczenie

Po zakończeniu testowania aplikacji przejdź do witryny Azure Portal i usuń aplikację.

Wybierz pozycję Grupy zasobów, a następnie wybierz utworzoną grupę zasobów.
Na stronie Grupy zasobów wybierz pozycję Usuń.
Wprowadź nazwę grupy zasobów i wybierz pozycję Usuń. Aplikacja i wszystkie inne zasoby utworzone w tym samouczku są teraz usuwane z platformy Azure.

Udostępnij za pośrednictwem