...
Damit ein neuer RESTful-Service als Typ zur Auswahl bei der REST-Page auftaucht, muss dieser RestfulServiceInterface implementieren.
Um nun zusätzlich die relevanten Links für HATEOAS bereitzustellen, muss zusätzlich das Interface \Brandbox\JoinRestful\Service\Hateoas\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
Methode | Signatur | Parameter |
|---|---|---|
getLink | public function getLink(Restful\Lib\Entity\RestPage $restPage, ?int $id = null): string; | RestPage, id des zu Grunde liegenden Datensatzes |
Die Standard-Services unter REST-Pages implementieren alle dieses Interface.
...
| Drawio | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Eine Beispielresponse könnte wie folgt aussehen:
...