2014-11-28 16 views

risposta

15

Swagger UI è uno strumento che prende i file delle specifiche di Swagger, li presenta visivamente e consente di eseguire le operazioni.

Swagger è una specifica per documentare e descrivere le API REST. La specifica può essere trovata qui - https://github.com/swagger-api/swagger-spec/. Il repository contiene la specifica stessa, schema json, campioni e così via. Il README principale del repository punta anche a strumenti aggiuntivi, comprese librerie e framework per produrre le specifiche.

Quando si tratta di creare specifiche Swagger, è possibile utilizzare uno dei framework e integrarlo con il codice esistente per generare automaticamente tale documentazione.

Se non si dispone di un'applicazione esistente o si preferisce documentarla manualmente, è possibile utilizzare lo strumento Editor Swagger o l'editor di testo di propria scelta.

+0

Grazie webron, è possibile fornire un'immagine chiara su swagger –

+0

Ho un'API Swagger esistente in esecuzione. Ora, cosa è necessario per l'interfaccia utente di Swagger per poter mostrare la documentazione della mia API? L'apertura di './Dist/index.html' e la navigazione verso la mia swagger api non lo interrompe. Devo servire 'swagger.json' manualmente tramite http? La mia API ha bisogno di un endpoint extra dove serve solo il file .json? Grazie per il chiarimento. – atripes

+3

La domanda non è chiara e manca di dettagli. Suggerirei di iniziare una nuova domanda con tutti i dettagli qui o utilizzare il nostro gruppo Google che viene monitorato più da vicino. – Ron