Описание тега redoc
0
ответов
Ошибка при включении ReDoc в API-платформе
Версия платформы API: 1.2 Это мой текущий файл конфигурации api_platform: api_platform: enable_swagger_ui: false enable_re_doc: true mapping: paths: ['%kernel.project_dir%/src/Entity'] Я получил эту ошибку, когда я включил ReDoc: (1/1) InvalidConfig…
26 фев '19 в 10:03
1
ответ
Как вы используете reDoc с несколькими файлами
Моя документация по API становится достаточно большой, и мне было интересно, можно ли отделить openapi.yml файл в отдельно управляемые чанки вместо того, чтобы объединить все это в один и иметь reDoc (или какой-либо другой инструмент), объединить ег…
13 фев '19 в 05:28
1
ответ
Swagger Redoc CORS проблема с файлом JSON, размещенным на другом сервере
Я пытаюсь загрузить файл JSON с Redoc. Этот файл размещен на другом сервере. Я получаю эту ошибку: http://www.whatever-server.com/swagger/vs/swagger.json заблокирован политикой CORS: в запрошенном ресурсе отсутствует заголовок "Access-Control-Allow-…
19 фев '19 в 22:03
1
ответ
Добавьте текстовые разделы в Swagger, используя Swashbuckle
Я использую Swashbuckle с Redoc для документирования своего ASP.NET Core 2.2 API. Живая демоверсия ReDoc имеет набор разделов вверху (например, "Введение") с некоторыми пользовательскими HTML. Я хочу создать похожие разделы в своем API, но не вижу, …
22 янв '19 в 09:31
0
ответов
Как настроить конечные точки API в документации Redoc API
Я использую redoc в django==2.0 для документирования некоторых django API. Я заметил, что по умолчанию redoc будет называть конечные точки автоматически, как вы можете видеть на изображении ниже с левой стороны. Скорее всего, я не хочу использовать …
28 мар '19 в 08:20
1
ответ
Как добавить x-code-samples для ReDoc с помощью Swashbuckle.AspNetCore?
Каков наилучший способ добавить примеры кода x для ReDoc в swagger.json через Swashbuckle.AspNetCore.Annotations? РЕДАКТИРОВАТЬ (30 марта 2019 г.) Я надеюсь, что это лучшее объяснение. В Swashbuckle.AspNetCore есть способ добавить контент в сгенерир…
24 мар '19 в 22:48
1
ответ
Как изменить обязательные поля для POST и PUT в Swashbuckle?
Я несу ответственность за ведение документации API компании. Наш API написан на ASP.NET. Недавно я перешел на использование Swashbuckle 5.6.0, который работает хорошо. Проблема, с которой я столкнулся, заключается в следующем: Например, мы разделяем…
27 мар '19 в 14:39
1
ответ
Включить XML-комментарии для перечислений в документацию OpenAPI на основе Swagger и ReDoc
У нас есть перечисления в нашем проекте ASP.NET Core 2.2, прокомментированные так: /// <summary>Theme for the UI</summary> public enum Theme { /// <summary>Dark backgrounds, lighter texts</summary> Dark, /// <summary>Li…
17 апр '19 в 12:23
0
ответов
ASP.Net MVC WebAPI Swagger и ReDoc формат Enums
В MVC WebAPI у меня есть viewModel, свойство которого определено как перечисление. Redoc показывает текстовое представление перечисленного списка. Есть ли способ также показать числовые значения тоже. public enum MyTestEnum { Option1 = 1, Option2 = …
15 май '19 в 10:43
0
ответов
Удалить опцию меню аутентификации и детали аутентификации для API
Мы используем drf_yasg с redocs для документирования Django Rest API, но я хотел бы удалить опцию меню Аутентификация и не показывать схему Аутентификации для нашего API
05 июн '19 в 01:09
0
ответов
Как указать ИЛИ объекты JSON в документации
Есть вопрос относительно того, как указать ИЛИ в документации JSON (используя Swagger). Я предпочел бы не иметь комментариев, указывающих, но хотел бы знать, каков типичный способ показать это? Допустим, у меня есть следующее: Тип метода: PATCH { Ob…
17 июн '19 в 22:24
0
ответов
Добавление выпадающего списка в redoc create с использованием файла свойств
В Swagger Redoc я создал внешнюю таблицу с помощью уценки, теперь мне нужно создать свой собственный выпадающий с помощью уценки. Можете ли вы помочь мне, что я могу реализовать то же самое.
10 авг '19 в 15:21
0
ответов
Как настроить блок "Образец ответа" в Swagger (Redoc)
Я пытаюсь настроить swagger с помощью Redoc, и все было хорошо, кроме блока "образец ответа", он пуст. Я знаю, что этот блок основан на сгенерированном JSON. И я обнаружил, что он пуст, потому что мой метод в RestController сам по себе ничего не воз…
13 авг '19 в 14:38
1
ответ
Загрузка файла JSON без использования URL-адреса?
Я создал документ JSON для службы OpenApi Restful. Мне было интересно, есть ли способ загрузить файл json без использования стороннего веб-сайта. Извините, если это глупый вопрос, я новичок в OpenApi. Вот HTML-код; <!DOCTYPE html> <html>…
03 фев '20 в 11:41
0
ответов
Есть ли какие-либо команды, которые Gradle не поддерживает в задаче exec
Я хочу сгенерировать HTML-документацию API из файла openapi3 YAML с помощью redoc-cli. Я не хочу вводить команду вручную при обновлении документации Итак, я узнал о задаче Gradle exec. каждый раз при сборке я хочу его выполнить. как это task<Exec…
04 сен '20 в 21:47
0
ответов
Ошибка при добавлении компонента Redoc React в шаблон Visual Studio 2019
Я пытаюсь использовать Redoc как компонент React. Я начинаю с базового шаблона ASP.NET Core с React в Visual Studio 2019 со всеми параметрами по умолчанию. Я выполнил инструкции на странице Redoc и сначала выполнил: npm install redoc --save А потом …
23 сен '19 в 18:24
0
ответов
Настройка ReDoc на Localhost с использованием Swagger
Мне удалось настроить свое чванство на локальном хосте, и оно работает идеально, поскольку я пытаюсь реализовать CDN для ReDoc, чтобы улучшить внешний вид, ниже - это ошибка, которую я получаю, я использую Linux mint. Кто-нибудь когда-либо работал н…
18 окт '19 в 10:35
0
ответов
На странице DRF ReDoc API не отображаются методы PUT PATCH и DELETE
При доступе к автоматизированной документации для DRF API с помощью ReDoc отсутствует документация по методам PUT PATCH и DELETE представлений - отображаются только методы GET и POST. Единственный способ сделать видимыми PUT PATCH и DELETE, которые …
07 дек '19 в 22:23
1
ответ
Проблема повторного использования сериализаторов с django и drf-yasg
Я использую django, django drf и drf-yasg для создания записи моего BE и создания документации. У меня есть модель под названием User и сериализатор для пользователя: class UserSerializer(serializers.ModelSerializer): class Meta: model = users_model…
23 янв '20 в 22:06
0
ответов
Как я могу задокументировать динамическое поле с помощью ReDoc?
У меня есть динамическое поле, определенное для объекта запроса, например: /// <summary> /// Some description of this field /// <example>17.5 or MyString in some cases</example> /// </summary> public dynamic MyField { get; se…
04 мар '20 в 21:28