Workshop Web API Grundlagen

Ein Workshop über Grundlagen für Web / HTTP APIs vom Code zum App Service, als extra gibt es noch einen Teil für eine Web API welche eine Angular SPA bedient.

Vier Abschnitte:

• Web API
  • Web API mit ASP.NET Core
  • Web API mit Node.js und Nest.js
  • Web API mit FastAPI
• Web API + App
  • Web App mit ASP.NET Core und Angular.js

Azure Infrastruktur

Alternatives Deployment

$Name = Read-Host "Dein Kürzel (3-4 Zeichen)"
New-AzResourceGroupDeployment -ResourceGroupName "az4db-wissenstransfer" -TemplateUri "https://raw.githubusercontent.com/sweetnordic/workshop-web-api/main/.azure/azuredeploy.json" -DeploymentName "ws-$($Name)-api" -TemplateParameterObject @{ "Name" = $Name }

Grundlagen

Im Bereich der Web APIs wird unterschieden in zwei Bereichen, HTTP und REST. HTTP API ist die Grundlagen und die RESTful API sollte das Ziel sein. Zu dem Thema RESTful APIs gibt es viel zu lesen unter anderem hat Microsoft ein RESTful API Design Guide und RESTful API Guidelines.

Weitere Informationen zu RESTful APIs:

• RedHat - Was ist eine REST-API
• IBM - What is a REST API

Um eine API verständlicher zu machen, gibt es die Möglichkeit diese zu dokumentieren anhand der OpenAPI Specification. Dies ist eine spezielle Form geschrieben in JSON oder YAML und kann unter anderem von Swagger weiter verwendet werden.

Web Api Implementierung

ASP.NET Core Web API C#

Zur Abschnittsdokumentation

Node.js mit Nest.js Web API TypeScript

Zur Abschnittsdokumentation

FastAPI Web API python

Zur Abschnittsdokumentation

Flask Web API python

Zur Abschnittsdokumentation

ASP.NET Core Web API + Angular.js Web SPA

Zur Abschnittsdokumentation

Vergleich

Feature	aspdotnet	typescript	python + flask	python + fastapi
Web Server	kestrel or iis	express.js	Flask or gunicorn	uvicorn
Web Framework	asp.net	nestjs	Flask	fastapi
Datenbank Framework	entity framework	---	sqlalchemy	sqlalchemy
REST behavoir	asp.net	---	flask-smorest	fastapi
Model Validation	asp.net	---	---	pydantic