ZBÝVAJÍCÍ v ASP.NET Core
Když přejdete na webovou stránku, webový server komunikuje s prohlížeči pomocí HTML, CSS a JavaScriptu. Pokud s stránkou spolupracujete, například odesláním přihlašovacího formuláře nebo kliknutím na tlačítko koupit, prohlížeč tyto informace pošle zpět na webový server.
Podobným způsobem můžou webové servery komunikovat s širokou škálou klientů, včetně prohlížečů, mobilních zařízení, dalších webových serverů a dalších, pomocí webových služeb. Klienti rozhraní API komunikují se serverem přes HTTP a dva informace o Exchangi pomocí formátu dat, jako je JSON nebo XML. Rozhraní API se často používají v aplikacích s jednou stránkou (jednostránkové), které provádějí většinu logiky uživatelského rozhraní ve webovém prohlížeči a komunikují s webovým serverem primárně pomocí webových rozhraní API.
REST: společný vzor pro vytváření rozhraní API pomocí protokolu HTTP
Representational state transfer (REST) je architektonický styl pro vytváření webových služeb. Žádosti REST se provádějí přes HTTP pomocí stejných příkazů HTTP, které webové prohlížeče používají k načtení webových stránek a k posílání dat na servery. Příkazy jsou:
- Get – Tato operace slouží k načtení dat z webové služby.
- Post – Tato operace slouží k vytvoření nové položky dat ve webové službě.
- Put – Tato operace slouží k aktualizaci položky dat ve webové službě.
- Oprava – Tato operace slouží k aktualizaci položky dat ve webové službě tím, že popisuje sadu instrukcí, jak by měla být položka upravena. Tato operace se nepoužívá v ukázkové aplikaci.
- Odstranit – Tato operace slouží k odstranění položky dat ve webové službě.
Rozhraní API webových služeb, která vyhovují REST, se nazývají rozhraní RESTful API a jsou definovaná pomocí:
- Základní identifikátor URI.
- Metody HTTP, jako je například GET, POST, PUT, PATCH nebo DELETE.
- Typ média pro data, například JavaScript Object Notation (JSON) nebo XML.
Rozhraní API bude často potřebovat poskytování služeb pro několik různých souvisejících věcí. Pizza API může například spravovat pizzas, zákazníky a objednávky. Provádíme Směrování na mapování identifikátorů URI do logických divizí v našem kódu, takže požadavky na http://localhost:5000/Pizza jsou směrovány na PizzaController , zatímco požadavky na http://localhost:5000/order jsou směrovány na OrderController .
Výhody vytváření rozhraní API v ASP.NET Core
pomocí ASP.NET můžete použít stejné rozhraní a vzory pro sestavování webových stránek a služeb. To znamená, že můžete znovu použít třídy modelů, logiku ověřování a dokonce i obsluhu webových stránek a služeb ve stejném projektu. Tento přístup má několik výhod.
Zvýhodnění: jednoduchá serializace
ASP.NET byla navržena pro moderní webové prostředí. Koncové body automaticky serializovat vaše třídy do nesprávně formátovaného formátu JSON mimo pole. Nevyžaduje se žádná speciální konfigurace. Samozřejmě může být serializace upravena pro koncové body, které mají jedinečné požadavky.
Výhody: ověřování a autorizace
Zabezpečené koncové body rozhraní API s integrovanou podporou pro oborové standardní webové tokeny JSON (JWT). Autorizace na základě zásad vám dává flexibilitu při definování výkonných pravidel řízení přístupu, a to vše v kódu.
Zvýhodnění: směrování spolu s vaším kódem
ASP.NET umožňuje definovat trasy a příkazy vložené s vaším kódem pomocí atributů. Data z cesty požadavku, řetězce dotazu a textu žádosti jsou automaticky svázány s parametry metody.
Zvýhodnění: standardně https
Protokol HTTPS je důležitou součástí moderních webových rozhraní API. Pro zajištění ochrany osobních údajů a zajištění, že volání rozhraní API nejsou zachycena a měněna mezi klientem a serverem, spoléhá na komplexní šifrování. ASP.NET poskytuje prvotřídní podporu pro HTTPS vycházející ze seznamu. Automaticky vygeneruje testovací certifikát a snadno ho naimportuje, aby bylo možné povolit místní HTTPS, aby bylo možné aplikace spouštět a ladit bezpečně, než je publikujete.
Zvýhodnění: sdílení kódu & znalostí s aplikacemi .NET
Využijte své dovednosti a ekosystém .NET ke sdílení logiky z webového rozhraní API s dalšími aplikacemi, které jsou vytvořené pomocí rozhraní .NET, včetně mobilních aplikací, webů, stolních počítačů, služeb a dalších.
Testování webových rozhraní API pomocí rozhraní .NET HTTP REPL
Při vývoji tradičního webu budete obvykle zobrazovat a testovat práci ve webovém prohlížeči. Webová rozhraní API akceptují a vracejí data místo HTML, takže webový prohlížeč není nejlepším testovacím nástrojem webového rozhraní API. Jednou z nejjednodušších možností, jak používat k prozkoumávání a interakci s webovými rozhraními API je rozhraní .NET http REPL. REPL představuje pro OOP R ečíst-E Val-P isknout L. Je to jednoduchý a oblíbený způsob sestavování interaktivních prostředí příkazového řádku. V další části vytvoříte jednoduché webové rozhraní API a pak s ním budete pracovat pomocí .NET HTTP REPL.
Kontrola znalostí
Potřebujete pomoc? Projděte si našeho průvodce odstraňováním potíží nebo nahlaste potíže a uveďte konkrétní připomínky.