Swagger und RESTful Spring hateoas Ressourcen

Question

In meiner RESTful API erweitern alle Ressourcen die Spring ResourceSupport Basis, um Hassoas Principals von Entwurf zu gewährleisten. Zum Beispiel:

public class PoolResource extends ResourceSupport { 
    private String name; 
    ... 
} 

Ich verwende auch Swagger, und ich frage mich: ist es möglich, den Prahlerei-ui irgendwie zu konfigurieren, um die Eigenschaften zu ignorieren von ResourceSupport kommen?

(Swagger-ui bietet einen schönen und einfachen Frontend des API. Als einer der großen Vorteile von Swagger mit der API für die mit der API zu verstehen und zu spielen, um, einfach, die sind nicht einmal mit der REST-API vertraut ... solange die "links" und "rels" ins Bild kommen.)

Answer 1

Die einzige vernünftige Art, es zu verstecken, wäre, es vor dem Modell selbst zu verstecken (gibt es mehrere Möglichkeiten, das zu tun, obwohl, wenn Sie Spring MVC verwenden, ich bin mir nicht sicher, was Swagger-Springmvc unterstützt).

Sie könnten theoretisch swagger.js hacken, um es zu verstecken, aber das ist ein ganzes Abenteuer.

Answer 2

Ich würde vorschlagen, Swagger wegzuwerfen und einen Restclient wie Postman zu verwenden. Postman macht die von Spring-hateoas bereitgestellten Links klickbar, so dass Sie schnell durch die API navigieren können. Wenn Sie zusätzliche Informationen/Dokumentationen bereitstellen möchten, können Sie diese Anforderungen in einer Anforderungssammlung in Postman speichern und zur Verteilung exportieren. Nachdem ich mehrere Dokumentationstools für Restapis ausprobiert habe, darunter Raml, Swagger, Imkerei und schließlich Postman-Sammlungen in Kombination mit Hateaos, habe ich festgestellt, dass letzteres das ist, mit dem ich am meisten zufrieden bin.

Answer 3

mit Spring Data REST 2.4.0.RELEASE, Sie haben jetzt mehrere Formen von Metadaten:

• ALPS
• JSON Schema
• Installieren Sie den HAL-Browser über Feder-data-rest-hal-Browser modul und surfen über die hypermedia

Answer 4

Spring RestDocs wurde mit hypermedia im Hinterkopf gebaut. Es funktioniert, um den gleichen Vorteil wie swagger im Bereich "generated docs" zu bieten, ist aber nicht so URL-basiert.

http://docs.spring.io/spring-restdocs/docs/current/reference/html5/#getting-started-build-configuration

bestrebt, Ausgabe etwas mehr mit githubs docs (Hyermedia'd) auszurichten.

https://developer.github.com/v3/#current-version

Answer 5

Jeder sah HAL Browser

http://api.opensupporter.org/hb2/browser.html#/api/v1

Es hilft, das Netz von Beziehungen zwischen den Ressourcen sichtbar zu machen, so tut unbedingt Anfrage Beispiele für eine Ressource zeigen, aber hat Bereichen Dokumentation angezeigt werden .

Meine Gedanken sind, es wäre ein einfacher Weg, um eine Hateos-Implementierung in gewissem Maße selbst dokumentiert zu bekommen. Und vielleicht könnte einer dieser Hypermedia-Links eine prahlerische Webseite sein oder Akzeptable Werte könnten in den Dokumenten sein, die ich oben erwähnt habe.