Добавить документацию API на веб-сайт с использованием документа Swagger

Question

У меня есть базовая веб-страница и документ JSON документа Swagger моего API. Я не уверен, как реально добавлять данные из документа на веб-сайт, чтобы его можно было просматривать.

Я хочу создать размещенную документацию для API.

Это пример, приведенный Swagger: http://petstore.swagger.wordnik.com/#!/pet/addPet

ли я просто скачать Swagger UI и использовать его в сочетании с файлом JSON.

Но я не уверен в этом. Любые советы о том, как сделать что-то подобное, были бы очень полезными.

Answer 1

Swagger-ui - это в основном набор статических файлов, которые вы можете разместить на своем сервере для отображения вашего API.

Если вы не можете вносить какие-либо существенные изменения, вам просто нужно скопировать содержимое папки/dist на ваш сервер и разместить его как часть вашего приложения (или статический веб-сайт, не имеет значения).

Объект SwaggerUi может быть настроен в соответствии с вашими потребностями, включая URL-адрес спецификации, которую вы размещаете.

Имейте в виду, что если вы не размещаете ui и spec на одном и том же сервере (то есть тот же хост и тот же порт), вам необходимо включить CORS.