Einführung

Im Folgenden möchten wir Ihnen die Grundlagen der API von API as a Service vermitteln und Sie mit den von uns verwendeten Begrifflichkeiten und deren Definitionen vertraut machen.

Grundlegendes

Um eine API erstellen zu können sind normalerweise eine Reihe von Vorkehrungen notwendig. So muss beispielsweise ein Datenbankentwickler ein entsprechendes Schema entwerfen und bereitstellen und ein Programmierer Schnittstellen entwickeln und implementieren, damit Klienten, Applikationen oder Drittanbieter lesend und schreibend auf das Datenbanksystem zugreifen können.

Mit AaaS-API können Sie programmatisch PHP-APIs generieren und veröffentlichen. Wir stellen Ihnen Schnittstellen zur Verfügung, mit denen Sie sowohl Datenbankschemata entwickeln können als auch entsprechende Programmierschnittstellen für Ihre API-Konsumenten.

Begrifflichkeiten

AaaS-API bietet die Möglichkeit, ihre Projekte in Form von Repositorien zu modularisieren. Einem Repositorium widerum können eine Reihe von Services (Datenmodelle) zugeordnet werden, welche ihrerseits Datenbanktabellen aus dem von Ihnen erstellten Schema in Ihrem Datenbanksystem abbilden. Schlussendlich bestehen Services aus Feldern, mit denen Sie Ihren Datenmodellen Eigenschaften (Datenattribute) zuordnen können.

Begriff	Definition	Beispiel
Projekt	Eines Ihrer API-Projekte	Webanwendung
Repositorium	Eine Reihe von Projektmodulen	Blog, Shop
Service	Einem Projektmodul zugeordnete Datenmodelle	Post, Author, Product, Category
Feld	Einem Service zugeordnete Datenattribute	title, name, color, parent

Beispiel

Ihr API-Projekt könnte beispielsweise eine Webanwendung sein, die unter anderem verschiedene Module wie einen Blog und einen Onlineshop beinhaltet. Jedes Modul besteht aus entsprechenden Services:

• Das Blog-Modul könnte unter anderem einen Post-Service umfassen, der datenbanktechnisch Ihre Blog-Einträge abbildet.
• Das Shop-Modul könnte einen Product- und Category-Service beinhalten, die Produkte und Kategorien in Ihrer Datenbank repräsentieren.

Um den Services Eigenschaften zuordnen zu können, werden diese mit Attributen versehen:

• Dem Post-Service könnte ein title-Attribut zugeordnet sein, der den Titel Ihres Blog-Eintrages darstellt.
• Der Product-Service könnte ein color-Attribut enthalten, über den Sie die Farbe eines in Ihrer Datenbank befindlichen Produkte persistieren könnten.
• Der Category-Service könnte ein parent-Attribut beinhalten, welches Ihren API-Konsumenten die übergeordnete Kategorie anzeigt.

Die Möglichkeiten sind mannigfaltig. So könnten Sie im Shop-Modul auch Beziehungen (Relationen) unter den Services abbilden um beispielsweise eine Anzahl an Reihen der den Produkten zugeordneten Attribute zu gruppieren. Wenn Sie einen Onlineshop aufbauen möchten um später Bekleidung und Werkzeuge verkaufen zu können, dann benötigen Sie für die Produkte aus der Kategorie Bekleidung andere Attribute als für die Produkte aus der Kategorie Werkzeuge. Eine mögliche Lösung bestünde dementsprechend in der Separierung und Gruppierung der Attribute der den unterschiedlichen Kategorien zugeordneten Produkte.

Durch die von uns zur Verfügung gestellten Programmierschnittstellen werden Sie in der Lage sein, auch komplexe Anforderungen Ihrer API-Konsumenten zu erfüllen und sauber in Ihrem System abzubilden.