Požiadavky: Scalar je veľmi výkonný a dokáže automaticky generovať HTTP volací kód v rôznych jazykoch z dokumentácie API, pričom na zobrazenie dokumentácie API používa Scalar namiesto Swaggeru.
Po vydaní .NET 9 ASP.NET oficiálny tím Core oznámil, že Swashbuckle.AspNetCore (projekt poskytujúci nástroj Swagger pre ASP.NET Core API) bude odstránený z šablóny ASP.NET Core Web API. To znamená, že v budúcnosti, keď budeme vytvárať projekty Web API, dokumentácia Swagger API už nebude automaticky generovaná. Takže dnes skúsme použiť Scalar na dokumentáciu interaktívneho API v našom projekte EasySQLite .NET 9.
Väzba:Prihlásenie na hypertextový odkaz je viditeľné.
Dôvody odvolania Swaggera možno zhrnúť nasledovne:
- Swashbuckle zlá údržba: Projekt Swashbuckle už nie je aktívne udržiavaný komunitnými vlastníkmi, mnohé problémy zostávajú nevyriešené a oficiálna verzia kompatibilná s .NET 8 nebola vydaná.
- Obrátime sa na Microsoft.AspNetCore.OpenApi: Tím ASP.NET Core rozšíri schopnosti Microsoft.AspNetCore.OpenApi, aby nahradil Swashbuckle a umožnil generovanie dokumentácie OpenAPI.
- Existujúce alternatívy: Okrem Swashbuckle podporujú ďalšie projekty ako NSwag generovanie dokumentácie OpenAPI a generovanie klient/server kódu, čo umožňuje vývojárom vybrať si vhodné riešenie podľa potrieb projektu.
- Vylepšená podpora zabudovaných API: Od ASP.NET Core 3.1 poskytuje framework podporu metadát, ako napríklad ApiExplorer. V kombinácii s integrovanou podporou .http súborov vo Visual Studio a Visual Studio Code je testovanie a ladenie API ešte lepšie.
- Propagácia OpenAPI ako základnej súčasti: ASP.NET tím Core plánuje ďalej vylepšiť integráciu OpenAPI v .NET 9, aby sa stal kľúčovou súčasťou zameranou na generovanie dokumentácie OpenAPI vo formáte JSON.
Skalár
Scalar je výkonný a ľahko použiteľný nástroj na generovanie API klientov a dokumentácie, vhodný pre API projekty všetkých veľkostí, podporujúci viaceré programovacie jazyky a platformy.
Open Source adresa:Prihlásenie na hypertextový odkaz je viditeľné.
ASP.NET Core integruje skalár
Integrovaná dokumentácia:Prihlásenie na hypertextový odkaz je viditeľné.
Vytvorte ASP.NET projekt Core 9, ktorý bude uvedený nasledovne:
Pridajte služby a skalárny middleware v Program.cs, s kódom nasledovným:
Edit WeatherForecastController.cs ovládač, kód nasledovný:
Spustite projekt, otvorte prehliadač a navštívte:http://localhost:5088/api-docs, ako je znázornené na obrázku nižšie:
Môžete si zvoliť generovanie špecifického volacieho kódu pre HTTP knižnice v rôznych jazykoch. Na príklade knižnice C# HttpClient je generovaný kód nasledovný:
Podporuje tiež online testovanie rozhrania. Kliknite na tlačidlo Test request, vyplňte údaje o príspevku a potom kliknite na odoslať požiadavku, ako je uvedené nižšie:
Prispôsobiť predvoleného HTTP klienta. Pre C# tímy chceme otvoriť API dokumentáciu rozhrania, ktoré automaticky zobrazuje kód volania C# HttpClient. Ak nechcete vyberať manuálne každý prvýkrát, nakonfigurujte nasledovne:
Vymažte funkciu Ask AI a odstráňte tlačidlo Ask AI Agent. Táto funkcia pôsobí trochu zbytočne. Kód je nasledovný:
Ako je uvedené nižšie:
Po vymazaní, ako je uvedené nižšie:
Podobne, vypnite funkčnosť MCP, naprogramujte nasledovne:
Kompletná konfigurácia je nasledovná:
Pridajte JWT autentifikáciu a preneste hlavičku požiadavkyToken na nositeľa
Pridajte bezpečnostné požiadavky do celej dokumentácie OpenAPI, kód nasledovne:
Ako je uvedené nižšie:
OpenID Connect (OIDC):Prihlásenie na hypertextový odkaz je viditeľné.
Referencia:
Prihlásenie na hypertextový odkaz je viditeľné.
Prihlásenie na hypertextový odkaz je viditeľné. |
ZverejnenéPred 5 minútami
|
|
|
|
Prenajímateľ|
ZverejnenéPred 1 minútou
|
