Reikalavimai: "Scalar" yra gana galingas ir gali automatiškai generuoti HTTP iškvietimo kodą įvairiomis kalbomis iš API dokumentacijos, naudojant "Scalar", o ne "Swagger", kad būtų rodoma API dokumentacija.
Išleidus .NET 9 ASP.NET oficiali "Core" komanda paskelbė, kad "Swashbuckle.AspNetCore" (projektas, teikiantis "Swagger" įrankį "ASP.NET Core API") bus pašalintas iš "ASP.NET Core Web API" šablono. Tai reiškia, kad ateityje, kai kursime žiniatinklio API projektus, "Swagger" API dokumentacija nebebus automatiškai generuojama. Taigi šiandien pabandykime naudoti "Scalar" interaktyviai API dokumentacijai mūsų "EasySQLite .NET 9" projekte.
Saitas:Hipersaito prisijungimas matomas.
"Swagger" pašalinimo priežastis galima apibendrinti taip:
- Swashbuckle prasta priežiūra: Swashbuckle projektas nebėra aktyviai prižiūrimas bendruomenės savininkų, daugelis problemų lieka neišspręstos, o oficiali versija, suderinama su .NET 8, nebuvo išleista.
- Grįžtant prie Microsoft.AspNetCore.OpenApi: "ASP.NET Core" komanda pagerins Microsoft.AspNetCore.OpenAPI galimybes pakeisti "Swashbuckle" ir įgalinti "OpenAPI" dokumentacijos generavimą.
- Esamos alternatyvos: Be Swashbuckle, kiti projektai, tokie kaip NSwag, palaiko OpenAPI dokumentacijos generavimą ir kliento / serverio kodo generavimą, todėl kūrėjai gali pasirinkti tinkamą sprendimą pagal projekto poreikius.
- Patobulintas integruotas API palaikymas: pradedant nuo ASP.NET Core 3.1, sistema teikė metaduomenų palaikymą, pvz., ApiExplorer. Kartu su "Visual Studio" ir "Visual Studio Code" integruotu .http failų palaikymu API testavimo ir derinimo patirtis yra dar geresnė.
- OpenAPI kaip pagrindinio komponento reklamavimas: ASP.NET Core komanda planuoja dar labiau patobulinti OpenAPI integraciją į .NET 9, paversdama ją pagrindiniu komponentu, orientuotu į JSON formato OpenAPI dokumentacijos generavimą.
Skaliarinis
"Scalar" yra galingas ir lengvai naudojamas API kliento ir dokumentacijos generavimo įrankis, tinkantis bet kokio dydžio API projektams, palaikantis kelias programavimo kalbas ir platformas.
Atvirojo kodo adresas:Hipersaito prisijungimas matomas.
"ASP.NET Core" integruoja "Scalar"
Integruota dokumentacija:Hipersaito prisijungimas matomas.
Sukurkite "ASP.NET Core 9" projektą, nurodytą taip:
Pridėkite paslaugas ir skaliarinę tarpinę programinę įrangą Program.cs, naudodami tokį kodą:
Redaguokite WeatherForecastController.cs valdiklį, kodą taip:
Paleiskite projektą, atidarykite naršyklę ir apsilankykite:http://localhost:5088/api-docs, kaip parodyta toliau pateiktame paveikslėlyje:
Galite pasirinkti generuoti konkretų HTTP bibliotekų skambučio kodą skirtingomis kalbomis. Kaip pavyzdį paėmus C# HttpClient biblioteką, sugeneruotas kodas yra toks:
Jis taip pat palaiko internetinės sąsajos testavimą. Spustelėkite mygtuką Testo užklausa, užpildykite įrašo duomenis, tada spustelėkite siųsti, kad išsiųstumėte užklausą, kaip parodyta toliau:
Tinkinkite numatytąjį HTTP klientą. C# komandoms norime atidaryti API dokumentacijos sąsają, kuri automatiškai rodo C# HttpClient iškvietimo kodą. Jei nenorite rankiniu būdu pasirinkti kiekvieną pirmą kartą, sukonfigūruokite taip:
Ištrinkite funkciją "Klausti dirbtinio intelekto" ir pašalinkite mygtuką "Klausti dirbtinio intelekto agento". Ši funkcija atrodo šiek tiek nereikalinga. Kodas yra toks:
Kaip parodyta žemiau:
Po ištrynimo, kaip parodyta toliau:
Panašiai išjunkite MCP funkciją, koduokite taip:
Visa konfigūracija yra tokia:
Pridėkite JWT autentifikavimą ir perkelkite užklausos antraštęNešėjo žetonas
Pridėkite saugos reikalavimus visai OpenAPI dokumentacijai, koduokite taip:
Kaip parodyta žemiau:
"OpenID Connect" (OIDC):Hipersaito prisijungimas matomas.
Nuoroda:
Hipersaito prisijungimas matomas.
Hipersaito prisijungimas matomas. |
Paskelbtaprieš 5 minutes
|
|
|
|
Savininkas|
PaskelbtaPrieš 1 minutę
|
