Nõuded: Scalar on üsna võimas ja suudab automaatselt genereerida HTTP kutsekoodi erinevates keeltes API dokumentatsioonist, kasutades Scalarit Swaggeri asemel API dokumentatsiooni kuvamiseks.
Pärast .NET 9 ASP.NET väljalaskmist teatas ametlik Core meeskond, et Swashbuckle.AspNetCore (projekt, mis pakub Swagger tööriista ASP.NET Core API jaoks) eemaldatakse ASP.NET Core Web API mallilt. See tähendab, et tulevikus, kui loome Web API projekte, ei genereerita Swagger API dokumentatsiooni enam automaatselt. Täna proovime kasutada Scalarit interaktiivse API dokumentatsiooni jaoks meie EasySQLite .NET 9 projektis.
Link:Hüperlingi sisselogimine on nähtav.
Swaggeri eemaldamise põhjused võib kokku võtta järgmiselt:
- Swashbuckle'i kehv hooldus: Swashbuckle'i projekti ei halda enam aktiivselt kogukonna omanikud, paljud probleemid on lahendamata ning ametlikku .NET 8-ga ühilduvat versiooni pole välja antud.
- Pöördudes Microsoft.AspNetCore.OpenApi poole: ASP.NET Core meeskond täiustab Microsoft.AspNetCore.OpenApi võimalusi, et asendada Swashbuckle ja võimaldada OpenAPI dokumentatsiooni genereerimist.
- Olemasolevad alternatiivid: Lisaks Swashbuckle'ile toetavad ka teised projektid nagu NSwag OpenAPI dokumentatsiooni genereerimist ja kliendi/serveri koodi genereerimist, võimaldades arendajatel valida sobiva lahenduse vastavalt projekti vajadustele.
- Täiustatud sisseehitatud API tugi: Alates ASP.NET Core 3.1-st on raamistik pakkunud metaandmete tuge, näiteks ApiExplorer. Koos Visual Studio ja Visual Studio Code'i sisseehitatud .http failide toega on API testimise ja silumise kogemus veelgi parem.
- OpenAPI edendamine põhikomponendina: ASP.NET Core meeskond plaanib veelgi täiustada OpenAPI integratsiooni .NET 9-s, muutes selle põhikomponendiks, mis keskendub JSON-formaadis OpenAPI dokumentatsiooni loomisele.
Skalaarne
Scalar on võimas ja lihtsasti kasutatav API kliendi- ja dokumentatsiooni genereerimise tööriist, mis sobib igas suuruses API projektidele ning toetab mitut programmeerimiskeeli ja platvorme.
Avatud lähtekoodiga aadress:Hüperlingi sisselogimine on nähtav.
ASP.NET Core integreerib skalaarse
Integreeritud dokumentatsioon:Hüperlingi sisselogimine on nähtav.
Loo ASP.NET Core 9 projekt, millele viidatakse järgmiselt:
Lisa teenused ja skalaarne vahetarkvara Program.cs. aastal, kood on järgmine:
Muuda WeatherForecastController.cs kontrollerit, kood on järgmine:
Käivita projekt, ava brauser ja külasta:http://localhost:5088/api-docs, nagu alloleval joonisel näidatud:
Võite valida konkreetse kutsekoodi genereerimise HTTP teekide jaoks erinevates keeltes. Võttes näiteks C# HttpClient teeki, on genereeritud kood järgmine:
See toetab ka veebipõhist liidese testimist. Klõpsa nuppu Testitaotlus, täida postituse andmed ja seejärel saada, et saata taotlus, nagu allpool näidatud:
Kohanda vaikimisi HTTP klient. C# meeskondade jaoks tahame avada API dokumentatsiooni liidese, mis kuvab automaatselt C# HttpClient kutsekoodi. Kui sa ei soovi iga kord käsitsi valida, seadista see järgmiselt:
Kustuta Ask AI funktsioon ja eemalda Ask AI Agent nupp. See funktsioon tundub veidi üleliigne. Kood on järgmine:
Nagu allpool näidatud:
Pärast kustutamist, nagu allpool näidatud:
Samamoodi, keela MCP funktsionaalsus, kood järgmiselt:
Täielik konfiguratsioon on järgmine:
Lisa JWT autentimine ja kanna päringu päistKandja märk
Lisa turvanõuded kogu OpenAPI dokumentatsiooni, koodi järgmiselt:
Nagu allpool näidatud:
OpenID Connect (OIDC):Hüperlingi sisselogimine on nähtav.
Viide:
Hüperlingi sisselogimine on nähtav.
Hüperlingi sisselogimine on nähtav. |
Postitatud5 minutit tagasi
|
|
|
|
Üürileandja|
Postitatud1 minut tagasi
|
