Požadavky: Scalar je velmi výkonný a dokáže automaticky generovat HTTP volací kód v různých jazycích z API dokumentace, přičemž používá Scalar místo Swaggeru pro zobrazení API dokumentace.
Po vydání .NET 9 ASP.NET oficiální tým Core oznámil, že Swashbuckle.AspNetCore (projekt poskytující nástroj Swagger pro ASP.NET Core API) bude odstraněn z šablony ASP.NET Core Web API. To znamená, že v budoucnu, když budeme vytvářet projekty Web API, už nebude dokumentace Swagger API automaticky generována. Dnes tedy zkusme použít Scalar pro dokumentaci interaktivního API v našem projektu EasySQLite .NET 9.
Propojit:Přihlášení k hypertextovému odkazu je viditelné.
Důvody odvolání Swaggera lze shrnout následovně:
- Špatná údržba Swashbuckle: Projekt Swashbuckle již není aktivně udržován komunitními vlastníky, mnoho problémů zůstává nevyřešených a oficiální verze kompatibilní s .NET 8 nebyla vydána.
- K Microsoft.AspNetCore.OpenApi: Tým ASP.NET Core rozšíří schopnosti Microsoft.AspNetCore.OpenApi, aby nahradil Swashbuckle a umožnil generování dokumentace OpenAPI.
- Existující alternativy: Kromě Swashbuckle podporují další projekty jako NSwag generování OpenAPI dokumentace a generování klient/server kódu, což umožňuje vývojářům vybrat vhodné řešení podle potřeb projektu.
- Vylepšená vestavěná podpora API: Od ASP.NET Core 3.1 poskytuje framework podporu metadat, například ApiExplorer. Ve spojení s vestavěnou podporou .http souborů ve Visual Studiu a Visual Studio Code je testování a ladění API ještě lepší.
- Propagace OpenAPI jako klíčové komponenty: ASP.NET tým Core plánuje dále zlepšit integraci OpenAPI v .NET 9, čímž se stane klíčovou součástí zaměřenou na generování dokumentace OpenAPI ve formátu JSON.
Skalár
Scalar je výkonný a snadno použitelný nástroj pro generování klientů a dokumentace pro API vhodné pro projekty všech velikostí, podporující více programovacích jazyků a platforem.
Open source adresa:Přihlášení k hypertextovému odkazu je viditelné.
ASP.NET Core integruje skalární systém
Integrovaná dokumentace:Přihlášení k hypertextovému odkazu je viditelné.
Vytvořte ASP.NET projekt Core 9, který je uveden následovně:
Přidejte služby a skalární middleware v Program.cs, s kódem následujícím:
Editace WeatherForecastController.cs ovladači, kódujte následovně:
Spusť projekt, otevři prohlížeč a navštiv:http://localhost:5088/api-docs, jak je znázorněno na obrázku níže:
Můžete si zvolit generování konkrétního volacího kódu pro HTTP knihovny v různých jazycích. Na příkladu knihovny C# HttpClient je generovaný kód následující:
Podporuje také testování online rozhraní. Klikněte na tlačítko Test Request, zadejte data příspěvku a poté klikněte na odeslat pro odeslání požadavku, jak je uvedeno níže:
Přizpůsobte výchozího HTTP klienta. Pro C# týmy chceme otevřít API dokumentační rozhraní, které automaticky zobrazí C# HttpClient volací kód. Pokud nechcete vybírat ručně poprvé poprvé, nakonfigurujte to následovně:
Smažte funkci Ask AI a odstraňte tlačítko Ask AI Agent. Tato funkce působí trochu zbytečně. Kód je následující:
Jak je uvedeno níže:
Po smazání, jak je uvedeno níže:
Podobně vypněte funkčnost MCP a naprogramujte následovně:
Kompletní konfigurace je následující:
Přidejte JWT autentizaci a přeneste záhlaví požadavkuNositelný žeton
Přidejte bezpečnostní požadavky do celé dokumentace OpenAPI, kód následovně:
Jak je uvedeno níže:
OpenID Connect (OIDC):Přihlášení k hypertextovému odkazu je viditelné.
Odkaz:
Přihlášení k hypertextovému odkazu je viditelné.
Přihlášení k hypertextovému odkazu je viditelné. |
ZveřejněnoPřed 5 minutami
|
|
|
|
Pronajímatel|
ZveřejněnoPřed 1 minutou
|
