Damit ein neuer RESTful-Service als Typ zur Auswahl bei der REST-Page auftaucht, muss er das Interface \Brandbox\JoinRestful\Join\Restful\Lib\Service\RestfulServiceInterface implementieren.Um nun zusätzlich die relevanten Links für
HATEOAS bereitzustellen, muss zusätzlich das Interface \Brandbox\JoinRestful\ServiceJoin\HateoasRestful\Lib\Service\RestfulServiceHateoasInterface implementiert werden.
Dieses Interface stellt die Methode getLink bereit, die vom HATEOAS-Service automatisch aufgerufen wird, um den dem Typ entsprechenden Link zu erhalten.
Interface \Brandbox\JoinRestful\Service\Hateoas\Lib\Service\RestfulServiceHateoasInterface
...
RestfulServiceInterface
| Methode | Signatur | Parameter |
|---|
| get | public function get(
?Restful\Lib\Entity\RestPage $restPage,
?Map\Lib\Entity\EtlMapProfile $etlMapProfile,
array $etlMapProperties,
array $parameters
): array; | - Aufgerufene REST-Page
- Verwendetes Mapping-Profil
- Verwendete Datenbankfelder (Mapping)
- Validierte Parameter
|
| post | public function post(
?Restful\Lib\Entity\RestPage $restPage,
?Map\Lib\Entity\EtlMapProfile $etlMapProfile,
array $etlMapProperties,
array $parameters
): array; | - Aufgerufene REST-Page
- Verwendetes Mapping-Profil
- Verwendete Datenbankfelder (Mapping)
- Validierte Parameter
|
| put | public function put(
?Restful\Lib\Entity\RestPage $restPage,
?Map\Lib\Entity\EtlMapProfile $etlMapProfile,
array $etlMapProperties,
array $parameters
): array; | - Aufgerufene REST-Page
- Verwendetes Mapping-Profil
- Verwendete Datenbankfelder (Mapping)
- Validierte Parameter
|
| delete | public function delete(
?Restful\Lib\Entity\RestPage $restPage,
|
?int $id = null ?Map\Lib\Entity\EtlMapProfile $etlMapProfile,
array $etlMapProperties,
array $parameters
): |
string;RestPage, id des zu Grunde liegenden Datensatzesarray; | - Aufgerufene REST-Page
- Verwendetes Mapping-Profil
- Verwendete Datenbankfelder (Mapping)
- Validierte Parameter
|
Die Standard-Services unter REST-Pages implementieren alle dieses Interface.
...