Вопросы с тегом «swagger»

135
Как исключить методы из документации Swagger в WebAPI с помощью Swashbuckle

У меня есть приложение C # ASP.NET WebAPI с документацией API, автоматически создаваемой с помощью Swashbuckle . Я хочу иметь возможность исключить определенные методы из документации, но я не могу понять, как сказать Swagger не включать их в вывод пользовательского интерфейса Swagger. Я чувствую,...

114
Как я могу представить 'Authorization: Bearer <token>' в спецификации Swagger (swagger.json)

Я пытаюсь передать, что схема аутентификации / безопасности требует установки следующего заголовка: Authorization: Bearer <token> Это то, что я основал на документации по чванству : securityDefinitions: APIKey: type: apiKey name: Authorization in: header security: - APIKey: []...

92
Как настроить Spring Security, чтобы разрешить доступ к URL Swagger без аутентификации

В моем проекте есть Spring Security. Основная проблема: невозможно получить доступ к URL-адресу swagger по адресу http: // localhost: 8080 / api / v2 / api-docs . Он говорит, что заголовок авторизации отсутствует или недействителен. Снимок экрана окна браузера. В моем pom.xml есть следующие записи...

88
Преобразование спецификации Swagger JSON в документацию HTML

Для некоторых REST API, написанных на PHP, меня попросили создать документацию Swagger , и, поскольку я не знал ни одного простого способа добавления аннотаций к этим существующим API и создания такой документации, я использовал этот редактор для создания некоторых на данный момент. Я сохранил...

85
'Простой' способ реализовать Swagger в приложении Spring MVC

У меня есть API ReSTFul, написанный на простом Spring (без Spring Boot, без всяких причуд!). Мне нужно внедрить в это Swagger. До сих пор КАЖДАЯ страница в Интернете сводила меня с ума запутанными конфигурациями и раздутым кодом, который я вообще не считал переносимым. Есть ли у кого-нибудь...

84
Swagger / OpenAPI - используйте $ ref для передачи повторно используемого определенного параметра

Допустим, у меня есть параметр вроде limit. Этот используется повсюду, и мне больно менять его везде, если мне нужно его обновить: parameters: - name: limit in: query description: Limits the number of returned results required: false type: number format: int32 Могу ли я использовать $ ref, чтобы...

11
Есть ли какие-нибудь альтернативы Springfox?

Последние два года я работал над Spring Boot Applications с Springfox. Springfox генерирует документацию и тестовый интерфейс для вашего REST API. Это было потрясающе. Но на самом деле проект Springfox мертв и не поддерживает новейшую Spring. У меня три вопроса Есть ли другой способ генерировать...

10
Аутентификация JWT и Swagger с .Net core 3.0

Я занимаюсь разработкой веб-API с .Net core 3.0 и хочу интегрировать его с SwashBuckle.Swagger. Он работает нормально, но когда я добавляю аутентификацию JWT, она не работает так, как я ожидаю. Для этого я добавил код ниже: services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new...