Описание тега swagger-play2

Это модуль для поддержки платформы play2 от playframework. Он написан на scala, но может использоваться с приложениями play2 на базе java или scala.
1 ответ

Как добавить определение безопасности apiKey в API Swagger-Play?

Я использую Swagger-Play с сервером Play 2.5 для создания определения Swagger. Мой API ожидает X-Auth-Token заголовок. Как я могу аннотировать свои классы API, чтобы swagger-play генерировал правильные определения безопасности? Это только кажется, ч…
0 ответов

Перечислите методы API в Swagger на основе ролей пользователей

У меня есть требование, где я хочу перечислить методы API в Swagger на основе пользовательских ролей. Например: Некоторые пользователи с базовым доступом могут использовать ограниченные методы API; Администратор может использовать все перечисленные …
03 сен '17 в 18:28
1 ответ

Как я могу легко обслуживать пользовательский интерфейс Swagger в корне моего микросервиса Scala Play2?

Я разрабатываю микросервис с Scala и Play 2.5 и пытаюсь документировать свои конечные точки с помощью Swagger. Я добавил веб-фрейм Swagger UI в мои зависимости: "org.webjars" % "swagger-ui" % "2.1.8-M1" И плагин Swagger Play2: "io.swagger" %% "swagg…
25 окт '16 в 06:16
5 ответов

Дополнительные параметры с Play 2 и Swagger

Я пытаюсь использовать Swagger для документирования API Play 2 REST, но swagger-play2 кажется, не понимают необязательные параметры, определенные с помощью Scala Option type - обычный способ сделать необязательный параметр в Play 2: GET /documents c…
18 фев '14 в 12:42
3 ответа

Настройка Swagger с помощью Play/Java-framework-2.5

Я пытаюсь настроить Swagger с моим проектом Play-2.5. Я следовал этому уроку, и он работал, но только для старой версии Play и не работал с Play-2.5. Поскольку проект перешел на Play-2.5, нам пришлось убрать конфигурацию swagger. Во-первых, проблема…
0 ответов

Swagger с игрой 2

Кто-нибудь пытался использовать Swagger с Play 2. У меня есть Play 2 Java-проект, и я пытаюсь интегрировать Swagger с ним без какой-либо удачи. я установил пакет, используя эту зависимость: "com.wordnik" %% "swagger-play2" % "1.3.7" но я продолжаю п…
3 ответа

Swagger Модель типов данных в ImplicitParam с Play Framework

Я пытаюсь использовать Swagger для документирования моего REST API. Следуя этому примеру, я комментирую конечные точки REST следующим образом: case class CreateItemRequest(title: String, body: String) @ApiOperation(value = "Create a new item", httpM…
1 ответ

Сериализация и десериализация объекта Play2 Html

У меня есть класс Case для документов. Чтобы сериализовать его и десериализовать в и из текста Json, я определил неявный объект Reads and Writes. Если мой класс Document содержит только Int и String, у меня нет проблем. Однако, когда у меня есть зна…
20 май '14 в 02:22
2 ответа

Настройте API Swagger с помощью Play 2.4

Столкнувшись с проблемой при настройке Swagger API с Play 2.4 Framework. Следуйте этому URL для настройки: https://github.com/swagger-api/swagger-play/tree/master/play-2.4/swagger-play2 После того, как конфигурация получает ошибку времени компиляции…
10 сен '15 в 09:35
0 ответов

Не могу ли я написать отдельные маршруты для каждой конечной точки (swagger-play)

Например, у меня сейчас есть две конечные точки: Жесткая проверка отказов Глобальный черный список Мне нужен отдельный маршрут для каждого. На первом маршруте я могу видеть только документ о проверке жесткого отказов. На втором маршруте я вижу толь…
04 сен '17 в 13:45
1 ответ

Как контролировать способ, которым Swagger генерирует модель / схему для типа

Я смог настроить Swagger с помощью Play и попробовать Swagger-ui... и я должен сказать, что это действительно здорово. Документирование действий моего контроллера с ApiOperation, ApiImplicitParaи т. д. было легко и работает как положено. Тем не мене…
24 фев '14 в 08:13
1 ответ

Swagger UI - не в состоянии расширить операции

Я пытаюсь использовать чванство с игровой рамкой. Я добавил аннотации API в код, и я могу получить к нему доступ через LOCALHOST:9000/ API-документы { apiVersion: "beta", swaggerVersion: "1.2", basePath: "http://localhost", resourcePath: "/metrics",…
1 ответ

Почему я получаю readystate неопределенным и статус 0, если я вызываю один и тот же остаток Api несколько раз в начале openshift?

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

Как создать чванливый ответ classof[AvroObject], без схемы

Я использую swagger-play2, и у меня есть эта аннотация: @ApiOperation(value = "",httpMethod = "POST",response = classOf[my.generated.avro.class]) Если это не аврокласс, а обычный класс кейсов, он работает отлично. Пример значения и модель в поле отв…
06 мар '19 в 03:33
0 ответов

Свойства модели класса дела не распознаются в Swagger-Play2 для Play 2.5 (Scala)

При создании спецификаций Swagger для API Play 2.5 Scala с Swagger-Play2 версии 1.5.3 ( https://github.com/swagger-api/swagger-play) мы не можем генерировать свойства определения на основе полей модели класса случая. Аннотации @ApiModel и @ApiModelP…
29 мар '19 в 13:05
1 ответ

Swagger интеграция с Play2

Я следовал за https://github.com/swagger-api/swagger-play/blob/master/play-2.7/swagger-play2/README.md и интегрированной версией swagger-play2 1.7.1 с моим приложением play 2.7. При доступе к конечной точке /swagger.json я получаю следующую ошибку и…
14 июн '19 в 11:20
0 ответов

Swagger-play2 - скрытие внутренних параметров

Я настроил библиотеку swagger-play2 версии 1.7.1 (для play framework версии 2.7) и успешно ее запустил. Наши методы контроллера имеют дополнительный вход: Http.Request request который передается через приложение для некоторых целей ведения журнала и…
1 ответ

Swagger-play2: как разрешить массив объектов в качестве ввода в пользовательском интерфейсе swagger с использованием аннотации @ApiImplicitParams?

Я пытаюсь написать чванство API для метода, который принимает массив объектов класса case. Я сделал следующее: package models import io.swagger.annotations.{ApiModel, ApiModelProperty} import play.api.data.Form import play.api.data.Forms.{mapping, n…
1 ответ

Интеграция Swagger с платформой Java Play

Моя цель - интегрировать Swagger с моим java play Framework Project. После ссылки введите описание ссылки здесь swagger-play Веб-сайт: https://github.com/swagger-api/swagger-play Краткое описание: создание спецификации Swagger API из файла маршрутов…
02 авг '20 в 21:28