Qual è il vantaggio di utilizzare Primavera REST Documenti confronto con Swagger

Question

Primavera REST Docs è stato rilasciato di recente e la documentazione dice:

Questo approccio si libera dalle limitazioni imposte da strumenti come Swagger

Quindi, volevo chiedere quando Spring REST Docs è preferibile utilizzare il confronto con Swagger e quali limitazioni libera.

Answer 1

Ho appena visto una presentazione qui che tocca la tua domanda tra gli altri argomenti:

https://www.youtube.com/watch?v=k5ncCJBarRI&t=26m58s

• Swagger non supporta ipermediali a tutti/è URI centric

• Il metodo di controllo Swagger del codice può essere in ritardo rispetto al codice. È possibile apportare modifiche al codice che Swagger non riesce a comprendere e non elaborerà correttamente finché Swagger non verrà aggiornato.

• Swagger richiede molte annotazioni ed è doloroso includere il testo descrittivo desiderato in un documento API nelle annotazioni.

• Ci sono solo alcune cose che Swagger non riesce a capire dall'ispezione del codice.

In ogni caso, questi sono solo un paio di punti. Il presentatore fa un lavoro molto migliore discutendo di quanto potrei.

Answer 2

C'è qualche limitazione con lo swagger e lo stack specifico della molla.

Ad esempio: con "param" nel mapping richieste è possibile definire più di un metodo con lo stesso url ans in modo da semplificare il codice. Ma spavalderia si mostrano solo un metodo

Answer 3

Ho pensato di inserire un po 'più di contesto attorno a Swagger, cos'è e cosa non lo è. Credo che questo potrebbe aiutare a rispondere alla tua domanda.

Swagger 2.0 viene adottato da un sacco di grandi nomi e grandi piattaforme come Microsoft Azure, Paypal, SwaggerHub.com, DynamicApis.com, ecc ... Qualcosa da tenere a mente è che Swagger is very simply a specification. Non è un quadro. Ci sono un sacco di frameworks creati per generare output Swagger che eseguono la scansione del codice guardando le informazioni API per creare il file JSON Swagger 2.0 che rappresenta la tua API. L'interfaccia utente di Swagger su cui vedi le tue API è guidata direttamente da questo file JSON Swagger 2.0. violinista per il check-out

E 'importante notare che un quadro che è stato creato per consentire di "utilizzare spavalderia" non è come Swagger deve lavorare (vale a dire che è completamente fino alla realizzazione del 3 ° quadro di partito). Se il framework che stai utilizzando per generare i tuoi documenti Swagger 2.0 e l'interfaccia utente non funziona per te, dovresti essere in grado di trovare un altro framework che generi gli artefatti di Swagger e sostituire le tecnologie.

Spero che questo aiuti.