Mithilfe des Knotens Kompilierungseinstellungen im Definitionsbaumfenster legen Sie Einstellungen fest, die für die Kompilierung der API benötigt werden.
Wenn Sie im Code Ihrer API Code aus anderen DLLs verwenden möchten (beispielsweise API-Dateien aus anderen Projekten), müssen Sie eine Assembly-Referenz erstellen, damit der Kompiler diese DLLs erkennt.
Um eine Assembly-Referenz zu erstellen
-
In der Menüleiste klicken Sie Ansicht > Navigation.
-
In der Navigation klicken Sie 
API-Projekte.
-
In der Baumstruktur doppelklicken Sie das API-Projekt, die Sie bearbeiten möchten.
-
Im Definitionsbaumfenster rechtsklicken Sie den Knoten Kompilierungseinstellungen.
-
Im Kontextmenü klicken Sie Assembly-Referenz.
Der Knoten Assembly-Referenz wird dem Knoten untergeordnet.
-
Im Definitionsbaumfenster klicken Sie den Knoten Assembly-Referenz.
-
In der Menüleiste klicken Sie Ansicht > Knotenbearbeitung.
-
Im Knotenbearbeitungsfenster geben Sie im Eingabefeld Referenzierte Assembly den Namen der Assembly ein, die Sie referenzieren möchten.
-
In der Menüleiste klicken Sie 
(Speichern).
Verwandte Themen
Damit die erstellten API-Dateien sinnvoll verwendet werden können, müssen Sie sie einem API-Projekt zuordnen.
Um API-Dateien einem API-Projekt zuzuordnen
-
In der Menüleiste klicken Sie Ansicht > Navigation.
-
In der Navigation klicken Sie API-Projekte.
-
In der Baumstruktur doppelklicken Sie das API-Projekt, die Sie bearbeiten möchten.
-
Im Definitionsbaumfenster rechtsklicken Sie den obersten Knoten.
-
Im Kontextmenü klicken Sie API-Datei-Referenz.
Der neue Knoten API-Datei-Referenz wird hinzugefügt.
-
Im Definitionsbaumfenster klicken Sie den Knoten API-Datei-Referenz.
-
In der Menüleiste klicken Sie Ansicht > Knotenbearbeitung.
-
Im Knotenbearbeitungsfenster geben Sie im Eingabefeld Control-ID eine eindeutige ID für den Knoten ein.
-
In der Auswahlliste Name wählen Sie die gewünschte Datei aus.
TIPP: Um direkt zur Dateidefinition zu springen, klicken Sie 
(Zum Definitionsobjekt).
-
In der Symbolleiste klicken Sie 
(Speichern).
Verwandte Themen
Sie können API-Projekte in den API Designer importieren. Der API Designer erkennt selbstständig, ob es sich um API-Projekte handelt und importiert diese als solche.
Um ein API-Projekt zu importieren
-
In der Menüleiste klicken Sie Bearbeiten > Objekt importieren.
-
Im Datei-Browser wählen Sie das gewünschte API-Projekt und klicken Sie Öffnen.
Das API-Projekt wird importiert.
Verwandte Themen
Mithilfe einer API-Datei erstellen Sie einen Aufruf, um zu einem konkreten Anwendungsfall Daten mit dem Server (oder der Datenbank) auszutauschen. Eine API-Datei kann zu mehr als einem Projekt gehören. In einer API-Datei können Sie beispielsweise eine API-Methode definieren.
HINWEIS: Wenn Sie eine neue API-Datei erstellen, mit der Sie eine neue API-Methode bereitstellen möchten, müssen Sie die API-Datei genauso benennen wie die Klasse. Achten Sie dabei auch auf die Groß- und Kleinschreibung.
Mithilfe des API Designers können Sie die folgenden Arten von API-Methoden in API-Dateien definieren.
Entity-Methoden
Entity-Methoden arbeiten mit kleinen Teilen des Objektmodells, um Daten aus der Datenbank zu lesen beziehungsweise in diese zu schreiben. Wenn Sie eine Entity-Methoden erstellen müssten Sie nur Tabellen- und Spaltennamen sowie ggf. einer Filterbedingung (WHERE-Klausel) angeben. Die interne Abarbeitung wird durch den API Server übernommen. Das Schema der Eingabe- und Ausgabedaten ist ebenfalls fest vorgegeben.
Beispiele zur Definition von Entity-Methoden finden Sie im SDK unter Sdk01_Basics\01-BasicQueryMethod.cs.
Benutzerdefinierte Methoden
Benutzerdefinierte Methoden sind Methoden, deren Abarbeitung, Eingabe- und Ausgabedaten Sie im Code vollständig definieren. Dieser Typ bietet daher die größte Flexibilität.
Beispiele zur Definition von benutzerdefinierten Methoden finden Sie im SDK unter Sdk01_Basics\03-CustomMethod.cs.
SQL-Methoden
SQL-Methoden sind Methoden, die Daten aus einer vordefinierten SQL-Abfrage über die API zur Verfügung stellen. Die Parameter einer Anfrage legen Sie als SQL-Parameter an.
Beispiele zur Definition von SQL-Methoden finden Sie im SDK unter Sdk01_Basics\02-BasicSqlMethod.cs.
Verwandte Themen
