Come condividere la documentazione di Swagger

Question

Recentemente ho iniziato a utilizzare Swagger per la mia documentazione, ma ci sono poche cose che non sono ancora chiare per me. Ho creato il mio documento YAML e ora vorrei poter condividere la mia documentazione in una pagina .pdf o HTML/Javascript con il resto del mio team. Non riesco a utilizzare SwaggerHub perché non hanno repository privati ​​e l'Editor di Swagger non sembra consentire di condividere il pannello sulla destra.

Giusto per essere chiari, vorrei essere in grado di ottenere qualcosa di simile:

Che cosa mi manca?

Answer 1

io sono di parte, come io lavoro su swaggerhub, ma questo è quello che il progetto è per:

https://swaggerhub.com

Da lì, si può spingere le caratteristiche del tuo spavalderia automaticamente github e anche fare altri collaboratori degli utenti su l'API (o solo di sola lettura).

Answer 2

DynamicApis.com è un nuovo portale API in via di sviluppo e dispone di una fantastica guida di integrazione che è possibile creare gratuitamente utilizzando Swagger JSON. Controlla https://www.dynamicapis.com/app/quickguide. Ecco un esempio di quello che ha generato un mio amico. http://bit.ly/1RIVvGN.

Ti consentono inoltre di creare il tuo portale API come GitHub e di caricare i tuoi documenti Swagger 2.0 per generare un'interfaccia utente fantastica per le tue API. Puoi visitare il loro sito e controllare alcuni portali di esempio per vedere anche l'interfaccia utente.

Generano collegamenti bit.ly per le guide di integrazione in modo da poter condividere con le persone.

Spero che questo aiuti!