Swagger e RESTful spring hatooas resources

Question

Nella mia API RESTful, tutte le risorse estendono la base di Spring ResourceSupport, al fine di garantire i principi di hateoas di progettazione. Per esempio:

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

sto utilizzando anche Swagger, e mi chiedevo: è possibile configurare la spavalderia-ui in qualche modo, di ignorare le proprietà provenienti da ResourceSupport?

(Swagger-ui fornisce un frontend piacevole e facile delle API. Come uno dei principali vantaggi dell'utilizzo di Swagger, l'API è facile da capire e da giocare con l'API per coloro, che sono non ho nemmeno familiarità con l'API REST ... finchè i "link" e "rels" entrano nell'immagine.)

Answer 1

L'unico modo ragionevole di nasconderlo sarebbe nasconderlo dal modello stesso (ci sono diversi modi per farlo, sebbene se usi Spring MVC, non sono sicuro di ciò che swagger-springmvc supporta).

Si potrebbe teoricamente incidere swagger.js per nasconderlo, ma questa è un'intera avventura.

Answer 2

Suggerirei di buttar via la spavalderia e utilizzare un restclient come Postman. Postman rende cliccabili i collegamenti forniti da Spring-hate, in modo da poter navigare attraverso l'API abbastanza rapidamente. Se si desidera fornire ulteriori informazioni/documentazione, è possibile salvare tali richieste in una raccolta di richieste in Postman ed esportarle per la distribuzione. Dopo aver provato diversi strumenti di documentazione per le apis di resto, tra cui raml, swagger, apiary e infine post-collezioni in combinazione con i hateaos, ho trovato che quest'ultimo è quello con cui sono più soddisfatto.

Answer 3

Con molla dati REST 2.4.0.RELEASE, ora avete molteplici forme di metadati:

• ALPS
• JSON Schema
• installare il browser HAL tramite primavera-dati-resto-hal browser modulo e navigazione via hypermedia

Answer 4

Spring RestDocs è stato progettato tenendo a mente Hyermedia. Funziona per fornire lo stesso vantaggio di swagger nel regno dei "documenti generati" ma non è basato su URL.

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

sforza di uscita qualcosa di più allinearsi con githubs docs (Hyermedia'd).

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

Answer 5

Uno sguardo HAL Browser

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

E aiuta a visualizzare la rete di relazioni tra le risorse, in modo pretende necessariamente mostrare richiesta esempi per una risorsa, ma ha aree da mostrare la documentazione .

I miei pensieri sono che sarebbe un modo più semplice per ottenere un'autenticazione Hateos autodocumentata, in una certa misura. E forse uno di quei link ipermediali potrebbe essere un sito spavaldo o I valori accettabili potrebbero essere nei documenti che ho citato sopra.