Követelmények: A Scalar meglehetősen hatékony, és automatikusan képes HTTP híváskódot generálni különböző nyelveken az API dokumentációból, Swagger helyett a Scalart használva az API dokumentáció megjelenítésére.
A .NET 9 megjelenése után ASP.NET hivatalos Core csapat bejelentette, hogy a Swashbuckle.AspNetCore (egy olyan projekt, amely a ASP.NET Core API-hoz a Swagger eszközt biztosítja) eltávolítják a ASP.NET Core Web API sablonból. Ez azt jelenti, hogy a jövőben, amikor Web API projekteket hozunk létre, a Swagger API dokumentációja már nem generálódik automatikusan. Szóval ma próbáljuk ki a Scalart interaktív API dokumentációhoz az EasySQLite .NET 9 projektünkben.
Láncszem:A hiperlink bejelentkezés látható.
Swagger eltávolításának okai a következőképpen összefoglalhatók:
- Swashbuckle rossz karbantartás: A Swashbuckle projektet már nem tartják aktívan a közösség tulajdonosai, sok probléma megoldatlan maradt, és a .NET 8-cal kompatibilis hivatalos verzió nem jelent meg.
- A Microsoft.AspNetCore.OpenApi oldalra térve: A ASP.NET Core csapata fejleszti a Microsoft.AspNetCore.OpenApi képességeit, hogy leváltsa a Swashbuckle-t és lehetővé tegye az OpenAPI dokumentáció generálását.
- Meglévő alternatívák: A Swashbuckle mellett más projektek, mint az NSwag, támogatják az OpenAPI dokumentáció generálását és az ügyfél/szerver kódgenerálást is, lehetővé téve a fejlesztők számára, hogy a projekt igényei alapján válasszák ki a megfelelő megoldást.
- Fejlesztett beépített API támogatás: A Core 3.1 ASP.NET től kezdve a keretrendszer olyan metaadat-támogatást nyújt, mint például az ApiExplorer. A Visual Studio és a Visual Studio Code beépített .http fájltámogatásával együtt az API tesztelés és hibakeresés élménye még jobb.
- Az OpenAPI magkomponensként való népszerűsítése: ASP.NET Core csapata tovább fejleszti az OpenAPI integrációját a .NET 9-ben, így az alapvető komponens a JSON formátumú OpenAPI dokumentáció létrehozására fókuszál.
Skalár
A Scalar egy hatékony és könnyen használható API kliens és dokumentációs generáló eszköz, amely minden méretű API projekthez alkalmas, több programozási nyelvet és platformot támogatva.
Nyílt forráskódú cím:A hiperlink bejelentkezés látható.
ASP.NET Core integrálja a skalárt
Integrált dokumentáció:A hiperlink bejelentkezés látható.
Készíts egy ASP.NET Core 9 projektet, amelyet az alábbiak szerint említenek:
Hozzáadj szolgáltatásokat és skaláris middleware-t Program.cs-ben, a kód a következőként:
Szerkesztés WeatherForecastController.cs kontroller, a kód a következő:
Indítsd el a projektet, nyisd meg a böngésződet, és látogasd meg:http://localhost:5088/api-docs, ahogy az alábbi ábrán látható:
Választhatsz, hogy különböző nyelveken generálsz specifikus híváskódot HTTP könyvtárakhoz. A C# HttpClient könyvtárat példaként említve, a generált kód a következő:
Emellett támogatja az online interfész tesztelést is. Kattints a Tesztkérés gombra, töltsd ki a bejegyzés adatait, majd kattints a küldésre a kérés elküldéséhez, ahogy az alábbiakban látható:
Testreszabni az alapértelmezett HTTP klienst. C# csapatokhoz szeretnénk megnyitni az API dokumentációs felületet, amely automatikusan megjeleníti a C# HttpClient híváskódot. Ha nem akarsz minden alkalommal kézzel választani, konfiguráld a következőket:
Töröld az Ask AI funkciót, és távolítsd el az Ask AI Agent gombot. Ez a funkció kissé feleslegesnek tűnik. A kód a következő:
Ahogy az alábbiakban látható:
Törlés után, ahogy az alábbiakban látható:
Hasonlóképpen, kapcsold ki az MCP funkciót, a kód a következő:
A teljes konfiguráció a következő:
Hozzáadjuk a JWT hitelesítést, és vigyük a kérés fejlécétViselő Zsetonos
A teljes OpenAPI dokumentációhoz hozzáadott biztonsági követelményeket adjunk hozzá, kódoljuk az alábbikat:
Ahogy az alábbiakban látható:
OpenID Connect (OIDC):A hiperlink bejelentkezés látható.
Utalás:
A hiperlink bejelentkezés látható.
A hiperlink bejelentkezés látható. |
Közzétéve5 perce
|
|
|
|
Háziúr|
Közzétéve1 perce
|
