Requisiti: Scalar è piuttosto potente e può generare automaticamente codice di chiamata HTTP in linguaggi diversi dalla documentazione API, utilizzando Scalar invece di Swagger per visualizzare la documentazione API.
Dopo il rilascio di .NET 9 ASP.NET il team ufficiale di Core ha annunciato che Swashbuckle.AspNetCore (un progetto che fornisce lo strumento Swagger per l'API ASP.NET Core) sarebbe stato rimosso dal modello di ASP.NET Core Web API. Ciò significa che in futuro, quando creeremo progetti Web API, la documentazione Swagger API non sarà più generata automaticamente. Oggi proviamo quindi a usare Scalar per la documentazione interattiva delle API nel nostro progetto EasySQLite .NET 9.
Collegamento:Il login del link ipertestuale è visibile.
Le ragioni della rimozione di Swagger possono essere riassunte come segue:
- Scarsa manutenzione di Swashbuckle: Il progetto Swashbuckle non è più attivamente mantenuto dai proprietari della community, molti problemi rimangono irrisolti e non è stata rilasciata una versione ufficiale compatibile con .NET 8.
- Passiamo a Microsoft.AspNetCore.OpenApi: il team di ASP.NET Core migliorerà le capacità di Microsoft.AspNetCore.OpenApi per sostituire Swashbuckle e abilitare la generazione di documentazione OpenAPI.
- Alternative esistenti: oltre a Swashbuckle, altri progetti come NSwag supportano la generazione di documentazione OpenAPI e la generazione di codice client/server, permettendo agli sviluppatori di scegliere la soluzione più appropriata in base alle esigenze del progetto.
- Supporto API integrato migliorato: A partire da ASP.NET Core 3.1, il framework ha fornito supporto ai metadati come ApiExplorer. Combinato con il supporto integrato di Visual Studio e Visual Studio Code per file .http, l'esperienza di test e debug delle API è ancora migliore.
- Promuovere OpenAPI come componente centrale: ASP.NET team Core prevede di migliorare ulteriormente l'integrazione OpenAPI in .NET 9, rendendolo un componente centrale focalizzato sulla generazione di documentazione OpenAPI in formato JSON.
Scalare
Scalar è uno strumento potente e facile da usare per la generazione di client e documentazione API, adatto a progetti API di tutte le dimensioni, supportando molteplici linguaggi di programmazione e piattaforme.
Indirizzo Open Source:Il login del link ipertestuale è visibile.
ASP.NET Core integra lo scalare
Documentazione integrata:Il login del link ipertestuale è visibile.
Crea un progetto ASP.NET Core 9, con riferimento come segue:
Aggiungi servizi e middleware scalari in Program.cs, con il codice che segue:
Modifica WeatherForecastController.cs controller, codice come segue:
Avvia il progetto, apri il browser e visita:http://localhost:5088/api-docs, come mostrato nella figura sottostante:
Puoi scegliere di generare codice di chiamata specifico per librerie HTTP in linguaggi diversi. Prendendo come esempio la libreria HttpClient di C#, il codice generato è il seguente:
Supporta anche il test online dell'interfaccia. Clicca sul pulsante Richiesta di Test, compila i dati del post, poi clicca su invia per inviare la richiesta, come mostrato di seguito:
Personalizza il client HTTP predefinito. Per i team C#, vogliamo aprire l'interfaccia di documentazione API, che mostra automaticamente il codice della chiamata HttpClient C#. Se non vuoi selezionare manualmente ogni prima volta, configura come segue:
Elimina la funzione Ask AI e rimuovi il pulsante Ask AI Agent. Questa funzione sembra un po' ridondante. Il codice è il seguente:
Come mostrato di seguito:
Dopo la cancellazione, come mostrato di seguito:
Allo stesso modo, disabilita la funzionalità MCP, codifica come segue:
La configurazione completa è la seguente:
Aggiungi l'autenticazione JWT e porta l'intestazione della richiestaGettone portatore
Aggiungi i requisiti di sicurezza all'intera documentazione OpenAPI, codice come segue:
Come mostrato di seguito:
OpenID Connect (OIDC):Il login del link ipertestuale è visibile.
Riferimento:
Il login del link ipertestuale è visibile.
Il login del link ipertestuale è visibile. |
Pubblicato su5 minuti fa
|
|
|
|
Padrone di casa|
Pubblicato su1 minuto fa
|
