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
...
public function getLink(Restful\Lib\Entity\RestPage $restPage, ?int $id = null): string;
...
Die Standard-Services unter REST-Pages implementieren alle RestfulServiceInterface
Methode | Signatur |
|---|---|
get | public function get(): array; |
post | public function post(): array; |
put | public function put(): array; |
delete | public function delete(): array; |
Über \Brandbox\JoinRestful\Join\Restful\ContextProvider können jederzeit die dem aktuellen Aufruf zu Grunde liegende Seite, Mappingprofil, Feldmappings und Parameter abgeholt werden.
Folgende Standard-Services implementieren dieses Interface.
| Untergeordnete Seiten (Anzeige untergeordneter Seiten) |
|---|