Cerințe: Scalar este destul de puternic și poate genera automat cod de apel HTTP în diferite limbaje din documentația API, folosind Scalar în loc de Swagger pentru a afișa documentația API.
După lansarea .NET 9 ASP.NET echipa oficială Core a anunțat că Swashbuckle.AspNetCore (un proiect care furnizează instrumentul Swagger pentru API-ul ASP.NET Core) va fi eliminat din șablonul ASP.NET Core Web API. Aceasta înseamnă că, în viitor, când vom crea proiecte Web API, documentația API-ului Swagger nu va mai fi generată automat. Așadar, astăzi, să încercăm să folosim Scalar pentru documentația interactivă a API-ului în proiectul nostru EasySQLite .NET 9.
Legătură:Autentificarea cu hyperlink este vizibilă.
Motivele înlăturării lui Swagger pot fi rezumate astfel:
- Întreținere slabă a Swashbuckle: Proiectul Swashbuckle nu mai este întreținut activ de proprietarii comunității, multe probleme rămân nerezolvate, iar o versiune oficială compatibilă cu .NET 8 nu a fost lansată.
- Trecând la Microsoft.AspNetCore.OpenApi: echipa ASP.NET Core va îmbunătăți capabilitățile Microsoft.AspNetCore.OpenApi pentru a înlocui Swashbuckle și a permite generarea de documentație OpenAPI.
- Alternative existente: Pe lângă Swashbuckle, alte proiecte precum NSwag suportă generarea de documentație OpenAPI și generarea codului client/server, permițând dezvoltatorilor să aleagă soluția potrivită în funcție de nevoile proiectului.
- Suport API integrat îmbunătățit: Începând cu ASP.NET Core 3.1, cadrul a oferit suport pentru metadate precum ApiExplorer. Combinat cu suportul integrat al Visual Studio și Visual Studio Code pentru fișiere .http, experiența de testare și depanare API este și mai bună.
- Promovarea OpenAPI ca componentă de bază: ASP.NET echipa de bază plănuiește să îmbunătățească și mai mult integrarea OpenAPI în .NET 9, transformându-l într-un component de bază axat pe generarea documentației OpenAPI în format JSON.
Scalar
Scalar este un instrument puternic și ușor de folosit pentru generarea de client API și documentație, potrivit pentru proiecte API de toate dimensiunile, suportând multiple limbaje de programare și platforme.
Adresă Open Source:Autentificarea cu hyperlink este vizibilă.
ASP.NET Core integrează Scalar
Documentație integrată:Autentificarea cu hyperlink este vizibilă.
Creează un proiect ASP.NET Core 9, referitat după cum urmează:
Adaugă servicii și middleware scalar în Program.cs, cu codul după cum urmează:
Editare WeatherForecastController.cs controller, cod după cum urmează:
Lansează proiectul, deschide browserul și vizitează:http://localhost:5088/api-docs, așa cum se arată în figura de mai jos:
Poți alege să generezi cod de apel specific pentru biblioteci HTTP în diferite limbaje. Luând ca exemplu biblioteca HttpClient C#, codul generat este următorul:
De asemenea, suportă testarea interfeței online. Apasă butonul Cerere de testare, completează datele postării, apoi apasă pe trimite pentru a trimite cererea, așa cum se arată mai jos:
Personalizează clientul HTTP implicit. Pentru echipele C#, vrem să deschidem interfața de documentație API, care afișează automat codul apelului HttpClient C#. Dacă nu vrei să selectezi manual la fiecare prima dată, configurează după cum urmează:
Șterge funcția Ask AI și elimină butonul Ask AI Agent. Această funcție pare puțin redundantă. Codul este următorul:
Așa cum se arată mai jos:
După ștergere, așa cum se arată mai jos:
În mod similar, dezactivează funcționalitatea MCP și codează după cum urmează:
Configurația completă este următoarea:
Adaugă autentificarea JWT și păstrează antetul cereriiJeton purtător
Adăugați cerințe de securitate întregii documentații OpenAPI, codul este următorul:
Așa cum se arată mai jos:
OpenID Connect (OIDC):Autentificarea cu hyperlink este vizibilă.
Referință:
Autentificarea cu hyperlink este vizibilă.
Autentificarea cu hyperlink este vizibilă. |
Postat peAcum 5 minute
|
|
|
|
Proprietarul|
Postat peAcum 1 minut
|
