Leistungen
Leistungen
Überblick
Leistungsangebot
Kernkompetenzen
Schulungsthemen
In-House-Schulungen
Offene .NET-Seminare
Offene WPS-Seminare
Beratung
Coaching
Support
Softwareentwicklung
Entwickler-Vermittlung
.NET/Visual Studio
TFS/ALM/Scrum
Webprogrammierung
PowerShell
Konditionen
Anfrage/Kontakt
Beratung/Coaching
Beratung/Coaching
Beratungsthemen
Coaching
Unsere Berater
Referenzkunden
Konditionen
Angebotsanfrage
In-House-Schulungen
In-House-Schulungen
Überblick
Themen/Fachgebiete
Schulungskonfigurator
Konzepte
.NET/Visual Studio
C#
VB.NET
ASP.NET
Moderne Webanwendungen
TFS/ALM/Scrum
PowerShell
Konferenzvortraege
Referenzkunden
Unsere Trainer
Konditionen
Angebotsanfrage
Offene Schulungen
Offene Schulungen
Überblick .NET-Seminare
.NET/C#-Basisseminar
WPF (Desktop)
ASP.NET/AJAX (Web)
WCF/WF (SOA)
ADO.NET/EF (Data)
Windows PowerShell
.NET, C#, VB, Visual Studio
.NET, C#, VB, Visual Studio
Startseite
Beratung/Training
Offene .NET-Seminare
Einführung
Lexikon
Artikel
Bücher
Klassenreferenz
Programmiersprachen
Entwicklerwerkzeuge
Softwarekomponenten
World Wide Wings Demo
Codebeispiele
Scripting
ASP.NET
.NET 2.0
.NET 3.0/3.5
.NET 4.0/4.5
Community
Forum
Kommerzielle Leistungen
ASP.NET
ASP.NET
Startseite
Lexikon
Sicherheit
Konfiguration
Global.asax
Tracing
Technische Beiträge
Klassenreferenz
Programmiersprachen
Entwicklerwerkzeuge
Softwarekomponenten
PowerShell
PowerShell
Überblick
Beratung
In-House-Schulungen
Öffentliche Schulungen
Codebeispiele
Commandlet Extensions
Offene PowerShell-Seminare
Inhouse-Seminare
Windows
Windows
Startseite
Windows Runtime (WinRT)
Windows PowerShell
Windows Scripting
Windows-Schulungen
Windows-Lexikon
Windows-Forum
Windows Scripting
Windows Scripting
Startseite
Lexikon
FAQ
Buecher
Architektur
Skriptsprachen
Scripting-Hosts
Scripting-Komponenten
COM/DCOM/COM+
ADSI
WMI
Scripting-Tools
WSH-Editoren
Codebeispiele
ASP.NET
.NET-Scripting
Forum
Links
Kommerzielle Leistungen
Service
Service
Website-FAQ
Anmeldung/Login
Leser-Registrierung
Gast-Registrierung
Nachrichten/RSS
Newsletter
Foren
Weblog
Lexikon
Downloads
Support
Kontakt
Literaturtipps
Publikationen
Publikationen
Redaktionsbüro
Bücher
Fachartikel
Leser-Portal
Autoren gesucht!
Rezensionen
Über uns
Über uns
Holger Schwichtenberg
Team
Referenzkunden
Kundenaussagen
Referenzprojekte
Partner
Site Map
Weitere Websites
Tag Cloud
Impressum
Rechtliches

Erklärung des Begriffs: ASP.NET Web API
Was ist ASP.NET Web API?

Zurück zur Stichwortliste



Begriff ASP.NET Web API
Abkürzung
Synonyme/Aliase

Erläuterung des Begriffs ASP.NET Web API

Das ASP.NET Web API ist eine .NET-basierte Bibliothek von Microsoft zur Erstellung REST-basierter Webservices mit HTTP und XML/JSON. Das ASP.NET Web API ist eine Alternative zur Windows Communication Foundation (WCF).

Lizensierung: Open Source unter Apache 2.0-Lizenz
Status: ASP.NET Web API ist Teil von ASP.NET MVC
Erscheinungstermin: Version 1 im August 2012
Website: http://www.asp.net/mvc/mvc4

Hintergründe von Manfred Steyer



Die neue ASP.NET Web API wird die Erstellung von REST-basierten Services, welche auf so gut wie allen Plattformen konsumiert werden können, erheblich vereinfachen. Anders als beim Einsatz der WCF werden Details des darunterliegenden Protokolls nicht abstrahiert, weswegen der Entwickler volle Kontrolle über die auf HTTP-basierende Kommunikation hat.

Egal ob auf mobilen Geräten, in Web-Browsern oder bei Cloud-Services, egal ob auf der Java-Plattform, unter PHP oder .NET: HTTP wird überall unterstützt. Dies ist auch der Grund dafür, warum die REST-Bewegung, die den puren Einsatz von HTTP ohne zusätzliche Transportprotokolle wie SOAP oder WS-* fordert, in den letzten Jahren zunehmend an Bedeutung gewinnt.

Die ASP.NET Web API, welche im Rahmen von ASP.NET MVC 4 genutzt werden kann, wird in Zukunft die Entwicklung REST-basierter Services erheblich vereinfachen. Anders als WCF wird dabei das darunter liegende Protokoll nicht verborgen und abstrahiert, sondern ein direkter Zugriff auf die Möglichkeiten von HTTP gewährt. Ursprünglich sollte die Web API gemeinsam mit WCF verteilt werden. Allerdings entschied man sich bei Microsoft, dass sich ASP.NET MVC als übergeordnetes Framework besser eignet. Deswegen wurde sie von WCF Web API in ASP.NET Web API umbenannt. Ausgeliefert wird sie mit ASP.NET MVC 4.

Einen einfachen REST-Service erstellen


Möchte man REST-Services über einen Web-Server zur Verfügung stellen, sind diese in einem ASP.NET MVC 4-Projekt anzulegen. Alternativ dazu kann sich der Entwickler auch, wie weiter unten beschrieben, selbst um das Hosting kümmern. In diesen Fällen wird ein eigener Web-Server, der im Lieferumfang der Web API enthalten ist, in einer benutzerdefinierten Anwendung gestartet.

REST-Services leiten von ApiController ab (siehe Listing 1). Die vom Entwickler bereitgestellten Methoden dieser Klassen stellt Web API unter Verwendung von Konventionen via HTTP bereit. Beginnt der Name einer Methode zum Beispiel mit Get, kann sie über das HTTP-Verb GET erreicht werden. Dasselbe gilt analog für POST, PUT und DELETE. Weicht der Name einer Methode von dieser Konvention ab, kann diese mit den Attributen HttpGet, HttpPost, HttpPut und HttpDelete mit diesen Verben assoziiert werden (siehe FindHotelsBySterne in Listing 1).

Weitere Verben können mit dem Attribut AcceptVerbs zugewiesen werden. Beispiele dafür finden sich in Listing 2, wo unter anderem das benutzerdefinierte Verb X-ECHO zur Methode Echo zugewiesen wird. In der aktuellen BETA verhindert der Einsatz von AcceptVerbs jedoch nicht, dass Web API zusätzlich auch die erwähnten Konventionen anwendet. Aus diesem Grund könnte der Aufrufer die Methode GetImplementationInfo in Listing 2 sowohl über X-INFO als auch über GET erreichen. Damit GET per Konvention nicht automatisch zugewiesen wird, wird hier jedoch unter Verwendung des Attributes ActionName angegeben, dass intern der Name ImplementationInfo anstatt von GetImplementationInfo zu verwenden ist.

Listing 1


public class HotelsController : ApiController
{

   public Hotel GetHotel(int id)
   {
   var rep = new HotelRepository();
   var hotel = rep.FindById(id);
   if (hotel == null) throw new HttpResponseException(HttpStatusCode.NotFound);

   return hotel;
   }

   public Hotel PostHotel(Hotel hotel)
   {
   var rep = new HotelRepository();
   rep.Create(hotel);
   return hotel;
   }

   [HttpGet]
   public List<Hotel> FindHotelsBySterne(int minSterne)
   {
   var rep = new HotelRepository();
   var hotels = rep.FindBySterne(minSterne);
   return hotels;
   }

   […]
}


Listing 2


public class HotelsController : ApiController
{
   […]

   [AcceptVerbs("X-ECHO")]
   public List<Hotel> EchoHotels(List<Hotel> hotels)
   {
   return hotels;
   }

   [AcceptVerbs("X-INFO")]
   [ActionName("ImplementationInfo")]
   public string GetImplementationInfo()
   {
   […]
   }
}

Artikel in gedruckten Medien

  • Microsoft .NET 4.5 Update - Crashkurs
     (.NET 4.5 Update, 2012)
  • Querverweise zu anderen Begriffen im Lexikon

    Windows Communication Foundation
    Webservice
    Exception
    Attribut


    Dienstleistungen:

    Beratung/Consulting zu ASP.NET Web API

    Support zu ASP.NET Web API

    Schulungen zu diesem Thema: