Вопросы по теме 'swagger-2.0'
Swagger / OpenAPI - используйте $ ref для передачи повторно используемого определенного параметра
Допустим, у меня есть параметр типа limit . Этот используется повсюду, и мне больно менять его везде, если мне нужно его обновить:
parameters:
- name: limit
in: query
description: Limits the number of returned results...
46655 просмотров
schedule
19.10.2023
Аннотации Swagger и спецификация Swagger 2.0
Я разработал REST API с аннотациями Swagger. Мне удалось показать документацию api в приложении swagger-ui, очень приятно.
Проблема: я пытаюсь создать клиентов в соответствии с этой спецификацией, используя URL-адрес, предоставленный swagger в...
2170 просмотров
schedule
01.07.2023
Проблема пользовательского интерфейса Swagger с camelCase
У меня проблема с параметрами запроса, если они в формате camelCase.
например: http://localhost:9000/api/hello?personName=test
Этот формат не работает с пользовательским интерфейсом Swagger. Swagger не может получить какой-либо параметр,...
797 просмотров
schedule
16.03.2023
Доступ к Swagger ApiModelProperty
Я использую один и тот же объект как для своего запроса, так и для ответа на конечной точке REST. Можно ли аннотировать свойство с помощью ApiModelProperty(access = "response") , а затем аннотировать оставшийся метод конечной точки с помощью...
3365 просмотров
schedule
25.02.2023
Формат даты SpringFox в миллисекундах
Я использую SpringFox (Swagger) для документирования своих REST API. Одной из приятных функций Swagger является демонстрация примера модели и формата типа данных.
Теперь я настроил свои API для создания и использования дат в миллисекундах, но...
3308 просмотров
schedule
02.10.2023
Добавление зависимостей моментальных снимков Springfox 2.2.3 не удалось из-за отсутствия nexus-maven-repository-index.properties
Я настраиваю свой проект с версией моментального снимка Springfox 2.2.3 в IDEA 14 с gradle. Я следую инструкции 2.1.1. Снимок Gradle . Я потерпел неудачу с ошибкой, что репозиторий maven не может быть проиндексирован, и вижу исключение в журнале...
669 просмотров
schedule
03.09.2022
Пользовательский компаратор строк Swashbuckle не применяется для групп действий порядка
В Swashbuckle есть параметр OrderActionGroupsBy, который должен изменить порядок в API, но ничего из того, что я делаю, не работает, и я не могу определить, является ли это проблемой Swashbuckle или из-за моего IComparer. я делаю неправильно?
Это...
1788 просмотров
schedule
07.06.2023
Springfox неправильно генерирует документы Swagger для одной и той же конечной точки операции, разные параметры запроса
Springfox неправильно генерирует документ swagger для простого случая, подобного этому:
GET /api/departments - Gets all department
GET /api/departments?name=IT - Gets a department with name passed as query parameter
Это контроллер Spring:...
1504 просмотров
schedule
20.08.2023
Класс конфигурации Swagger2 не загружен в spring mvc
Я работаю над настройкой документации swagger2 для моего проекта Spring REST. Но когда я пытаюсь выполнить http://localhost:8085/swagger-ui.html , возвращается пустой page. Проблема в том, что мой класс bean-компонентов не загружается моим весенним...
1419 просмотров
schedule
05.02.2023
Swagger 2.0 Anyof
Что эквивалентно anyof в Swagger версии 2.0? Скажите, пожалуйста, как обновить мой файл json, потому что я хочу обновить свою документацию с swagger 1.0 до 2.0.
Спасибо за помощь.
9587 просмотров
schedule
19.02.2022
Можно ли определить повторно используемую операцию пути?
Мы добавляем поддержку CORS в наш Swagger API, который включает определение операции параметров для каждого пути. Поскольку это шаблонный код, мы хотим определить операцию опции один раз в разделе определений, например так:
"definitions":{...
108 просмотров
schedule
06.12.2022
Как изменить basePath для Springfox Swagger 2.0
Я запускаю службу, в которой пользовательский интерфейс Swagger доступен по адресу:
http://serviceURL/swagger-ui.html
Однако он находится за прокси, например:
http://proxyURL/serviceName
URL-адреса, сгенерированные пользовательским...
17647 просмотров
schedule
06.08.2022
Автоматическое создание конечных точек отдыха с использованием Swagger для Java
Мне поставили задачу найти лучший способ документирования большого API, разработанного с использованием jaxrs, для третьих лиц. Код в настоящее время хорошо документирован с помощью javadoc. Мой вопрос состоит в том, чтобы помочь определить лучший...
1037 просмотров
schedule
13.03.2023
Как изменить код состояния ответа для успешной работы в Swagger?
Как показано на изображении, для операции добавления указано «Класс ответа (состояние 200)». Однако операция добавления была реализована таким образом, что она никогда не возвращает 200. В случае успеха она возвращает 201.
Мой вопрос: как я могу...
7404 просмотров
schedule
12.11.2022
Как настроить Spring Security, чтобы разрешить доступ к URL Swagger без аутентификации
В моем проекте есть Spring Security. Основная проблема: невозможно получить доступ к URL-адресу swagger по адресу http://localhost:8080/api/v2/api-docs . Он говорит, что заголовок авторизации отсутствует или недействителен.
Снимок экрана окна...
155534 просмотров
schedule
11.05.2022
Избегайте шаблонов в Swagger 2.0
Мои API-интерфейсы уважают обычные коды состояния, и я обнаружил, что повторяю один и тот же текст в части ответов моего определения API.
404:
description: The resource doesn't exist
schema:
$ref:...
437 просмотров
schedule
15.12.2022
Описание аннотации API устарело
В Swagger @Api description устарел.
Устарело. Не используется в версии 1.5.X, сохранено для устаревшей поддержки.
Есть ли более новый способ предоставления описания?
40785 просмотров
schedule
25.05.2023
Как создать документацию с помощью maven-swagger-codegen-plugin?
Я настроил swagger-codegen-plugin так
<plugin>
<groupId>io.swagger</groupId>
<artifactId>swagger-codegen-maven-plugin</artifactId>
<version>2.1.5</version>...
2312 просмотров
schedule
24.12.2022
Ошибки Springfox Swagger Json
Я новичок в чванстве. У меня есть следующий код:
@RestController
@RequestMapping(value = { V1P})
@Api(value = V1P, description= "My Operations Management API")
public class MethodController {
/**
* @return -
*/...
203 просмотров
schedule
05.07.2023
Контроллер не отображается в swagger-ui.html
Я использую Swagger 2 с загрузкой без весны, и я также могу развернуть свое приложение на Tomcat и успешно запустить его. Но контроллер не появляется в swagger-ui.html , просто появляется пустая страница с зеленым заголовком чванства. Я потратил...
12187 просмотров
schedule
12.08.2022
