Zasoby Swagger i RESTful spring hateoas

Question

W moim interfejsie API RESTful wszystkie zasoby rozszerzają bazę Spring ResourceSupport, aby zapewnić zgodność z zasadami hateoas według projektu. Na przykład:

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

Używam również Swagger, i zastanawiałem się: czy jest to możliwe do skonfigurowania Swagger-ui jakoś ignorować właściwości pochodzących z ResourceSupport?

(Swagger-ui zapewnia miły i łatwy frontend API. Jako jeden z głównych zalet korzystania Swagger, API jest łatwe do zrozumienia i bawić się z API dla tych, którzy są nawet nie zna się z REST API ... dopóki "linki" i "relacje" pojawiają się na zdjęciu.)

Answer 1

Jedynym rozsądnym sposobem na ukrycie byłoby ukrywanie go przed samym modelem (są kilka sposobów na to, ale jeśli używasz Spring MVC, nie jestem pewien, co obsługuje swagger-springmvc).

Teoretycznie możesz zhakować plik swagger.js, aby go ukryć, ale to jest cała przygoda.

Answer 2

Proponuję wyrzucić swagger i użyć restclient jak Postman. Listonosz sprawia, że ​​linki udostępniane przez kliknięcia wiosna-hateo są klikalne, dzięki czemu możesz szybko poruszać się po interfejsie API. Jeśli chcesz podać dodatkowe informacje/dokumentację, możesz zapisać te żądania w zbiorze żądań w programie Listonosz i wyeksportować je do dystrybucji. Po tym, jak wypróbowałem kilka narzędzi dokumentujących reis apis, w tym raml, swagger, pasiekę i wreszcie kolekcje Listonosza w połączeniu z hateaos, stwierdziłem, że to ostatnie jest tym, z czego jestem najbardziej zadowolony.

Answer 3

ze sprężyną REST Danych 2.4.0.RELEASE, masz teraz wiele form metadanych:

• ALPS
• JSON Schema
• zainstalować HAL Browser poprzez wiosna-data-Rest-Hal-przeglądarce moduł i surfowanie za pośrednictwem hipermedia

Answer 4

Spring RestDocs został zbudowany z myślą o Hyermedia. Działa tak, by zapewnić taką samą korzyść, jak zbagatelizowanie w dziedzinie "wygenerowanych dokumentów", ale nie jest oparty na adresie URL.

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

dąży do wyjścia coś bardziej wyrównać z githubs Docs (Hyermedia'd).

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

Answer 5

Każdy wyglądał HAL Browser

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

To pomaga wizualizować sieć relacji między zasobami, więc nie robi koniecznie pokazać przykłady żądań do zasobu, ale ma obszarów do wyświetlenia dokumentacji .

Myślę, że byłby to łatwiejszy sposób na samodzielne udokumentowanie realizacji Hateos w pewnym zakresie. Być może jeden z hipermedialnych linków może być witryną oszałamiającą lub Dopuszczalne wartości mogą znajdować się w dokumentach wymienionych powyżej.