Prasības: Scalar ir diezgan jaudīgs un var automātiski ģenerēt HTTP zvana kodu dažādās valodās no API dokumentācijas, izmantojot Scalar, nevis Swagger, lai parādītu API dokumentāciju.
Pēc .NET 9 ASP.NET izlaišanas oficiālā Core komanda paziņoja, ka Swashbuckle.AspNetCore (projekts, kas nodrošina Swagger rīku ASP.NET Core API) tiks noņemts no ASP.NET Core Web API veidnes. Tas nozīmē, ka nākotnē, veidojot Web API projektus, Swagger API dokumentācija vairs netiks automātiski ģenerēta. Tāpēc šodien mēģināsim izmantot Scalar interaktīvai API dokumentācijai mūsu EasySQLite .NET 9 projektā.
Saikne:Hipersaites pieteikšanās ir redzama.
Swagger noņemšanas iemeslus var apkopot šādi:
- Swashbuckle slikta apkope: Swashbuckle projektu vairs aktīvi neuztur kopienas īpašnieki, daudzas problēmas paliek neatrisinātas, un oficiālā versija, kas ir saderīga ar .NET 8, nav izlaista.
- Pievēršoties Microsoft.AspNetCore.OpenApi: ASP.NET Core komanda uzlabos Microsoft.AspNetCore.OpenAPI iespējas aizstāt Swashbuckle un iespējot OpenAPI dokumentācijas ģenerēšanu.
- Esošās alternatīvas: Papildus Swashbuckle, citi projekti, piemēram, NSwag, atbalsta OpenAPI dokumentācijas ģenerēšanu un klienta/servera koda ģenerēšanu, ļaujot izstrādātājiem izvēlēties atbilstošu risinājumu, pamatojoties uz projekta vajadzībām.
- Uzlabots iebūvētais API atbalsts: sākot ar ASP.NET Core 3.1, sistēma ir nodrošinājusi metadatu atbalstu, piemēram, ApiExplorer. Apvienojumā ar Visual Studio un Visual Studio Code iebūvēto atbalstu .http failiem, API testēšanas un atkļūdošanas pieredze ir vēl labāka.
- OpenAPI kā pamatkomponenta popularizēšana: ASP.NET Core komanda plāno vēl vairāk uzlabot OpenAPI integrāciju .NET 9, padarot to par galveno komponentu, kas koncentrējas uz JSON formāta OpenAPI dokumentācijas ģenerēšanu.
Skalārs
Scalar ir jaudīgs un viegli lietojams API klientu un dokumentācijas ģenerēšanas rīks, kas piemērots visu lielumu API projektiem, atbalstot vairākas programmēšanas valodas un platformas.
Atvērtā koda adrese:Hipersaites pieteikšanās ir redzama.
ASP.NET Core integrē skalāru
Integrētā dokumentācija:Hipersaites pieteikšanās ir redzama.
Izveidojiet ASP.NET Core 9 projektu, uz kuru atsaucas šādi:
Pievienojiet pakalpojumus un skalāru starpprogrammatūru Program.cs ar šādu kodu:
Rediģējiet WeatherForecastController.cs kontrolieri, kodējiet šādi:
Palaidiet projektu, atveriet pārlūkprogrammu un apmeklējiet:http://localhost:5088/api-docs, kā parādīts attēlā:
Varat izvēlēties ģenerēt konkrētu izsaukuma kodu HTTP bibliotēkām dažādās valodās. Ņemot par piemēru C# HttpClient bibliotēku, ģenerētais kods ir šāds:
Tas atbalsta arī tiešsaistes saskarnes testēšanu. Noklikšķiniet uz pogas Testa pieprasījums, aizpildiet ziņas datus un pēc tam noklikšķiniet uz sūtīt, lai nosūtītu pieprasījumu, kā parādīts tālāk:
Pielāgojiet noklusējuma HTTP klientu. C# darba grupām mēs vēlamies atvērt API dokumentācijas interfeisu, kas automātiski parāda C# HttpClient izsaukuma kodu. Ja nevēlaties manuāli atlasīt katru pirmo reizi, konfigurējiet šādi:
Izdzēsiet funkciju Jautāt AI un noņemiet pogu Jautāt AI aģentam. Šī funkcija šķiet nedaudz lieka. Kods ir šāds:
Kā parādīts zemāk:
Pēc dzēšanas, kā parādīts zemāk:
Līdzīgi atspējojiet MCP funkcionalitāti, kodējiet šādi:
Pilnīga konfigurācija ir šāda:
Pievienojiet JWT autentifikāciju un pārnēsājiet pieprasījuma galveniUzrādītāja žetons
Pievienojiet drošības prasības visai OpenAPI dokumentācijai, kodējiet šādi:
Kā parādīts zemāk:
OpenID savienojums (OIDC):Hipersaites pieteikšanās ir redzama.
Atsauce:
Hipersaites pieteikšanās ir redzama.
Hipersaites pieteikšanās ir redzama. |
PublicētsPirms 5 minūtēm
|
|
|
|
Saimnieks|
Publicētspirms 1 minūtes
|
