Datasnap.DSService.TDSRESTService
Delphi
TDSRESTService = class(TDSService)
C++
class PASCALIMPLEMENTATION TDSRESTService : public TDSService
Eigenschaften
Typ | Sichtbarkeit | Quelle | Unit | Übergeordnet |
---|---|---|---|---|
class | public | Datasnap.DSService.pas Datasnap.DSService.hpp |
Datasnap.DSService | Datasnap.DSService |
Beschreibung
REST-Dienstimplementierung.
Anforderungsmethoden werden CRUD (EN)-Vorgängen wie folgt zugeordnet:
- GET: /Methodenklasse/Methodenname/Eingabeparameter[/Eingabeparameter]*
- JSON-Anforderung: {"execute":{"Methodenklasse.Methodenname":[Eingabeparameter[,Eingabeparameter]*]}}
- PUT: /Methodenklasse/Methodenname/Eingabeparameter[/Eingabeparameter]* und [Inhalt]
- JSON-Anforderung: {"execute":{"Methodenklasse.acceptMethodenname":[Eingabeparameter[,Eingabeparameter]*[,JSON-Wert]}}
- POST: /Methodenklasse/Methodenname/Eingabeparameter[/Eingabeparameter]* und [Inhalt]
- JSON-Anforderung: {"execute":{"Methodenklasse.updateMethodenname":[Eingabeparameter[,Eingabeparameter]*[,JSON-Wert]}}
- DELETE: /Methodenklasse/Methodenname/Eingabeparameter[/Eingabeparameter]*
- JSON-Anforderung: {"execute":{"Methodenklasse.cancelMethodenname":[Eingabeparameter[,Eingabeparameter]*]}}
Um eine Datenbankverbindung zu verwalten, könnten Sie beispielsweise Folgendes verwenden:
- PUT-Meldung http://mySite.com/datasnap/rest/Test/Connection/MSSQL1 Ergebnisse in der JSON-Anforderung
{"execute":{"Test.acceptConnection":["MSSQL1"]}}
- POST-Meldung http://mySite.com/datasnap/rest/Test/Connection/MSSQL2 Ergebnisse in der JSON-Anforderung
{"execute":{"Test.updateConnection":["MSSQL2"]}}
- GET-Meldung http://mySite.com/datasnap/rest/Test/Connection Ergebnisse in der JSON-Anforderung
{"execute":{"Test.Connection":[]}}
- DELETE-Meldung http://mySite.com/datasnap/rest/Test/Connection Ergebnisse in der JSON-Anforderung
{"execute":{"Test.cancelConnection":[]}}
Sie können diese Methoden folgendermaßen implementieren:
acceptConnection
öffnet eine Verbindung namens "MSSQL1".updateConnection
schließt die bestehende Verbindung (sofern vorhanden) und öffnet eine neue.Connection
gibt den Namen der aktuell geöffneten Verbindung zurück.cancelConnection
schließt die bestehende Verbindung, falls vorhanden.
Wenn Ausgabe- oder Rückgabeparameter festgelegt sind, werden diese in eine JSON-Antwort aufgenommen:
{
"result": [
parameterValue1,
parameterValue2,
// …
]
}
Wenn der Server eine Exception auslöst, dann lautet die JSON-Antwort:
{
"error": "Error message."
}