Вопросы по теме 'openapi'
Swagger: карта ‹строки, объекта›
Мне нужно документировать с помощью Swagger API, который использует как ввод, так и вывод карты объектов, индексированных строковыми ключами.
Пример:
{
"a_property": {
"foo": {
"property_1": "a string 1",...
57838 просмотров
schedule
03.04.2024
Напишите документ swagger, который использует несколько типов контента, например. application/json И application/x-www-form-urlencoded (без дублирования)
Я ищу элегантный способ определить API, который может использовать данные JSON, а также данные формы. Следующий фрагмент работает, но он не элегантен и требует уродливого кода в бэкенде. Есть ли лучший способ определить это?
Что сейчас работает:...
3167 просмотров
schedule
06.02.2024
Ошибка при создании документа OpenAPI с использованием инструментов endpoints-framework-tools
Я пытался добавить управление API в свой API Google Cloud Endpoints (2.0).
Я следил за документацией Google здесь , однако когда выполнив команду endpoints-framework-tools get-openapi-doc следующим образом:...
96 просмотров
schedule
09.04.2024
Создание файла Swagger для определенных конечных точек из другого файла Swagger или OpenAPI
Имея одну большую спецификацию Swagger / OpenAPI YAML, как я могу безопасно извлечь определенные конечные точки API и сгенерировать новый .yaml исключительно для них?
Конечные точки API легко идентифицировать с определенного уровня (например, с...
534 просмотров
schedule
27.09.2022
Как описать данные динамической формы с помощью OpenAPI (Swagger)?
Я пытаюсь создать определение OpenAPI для этого запроса multipart/form-data :
curl -X POST \
http://localhost:1234/api/v1/Submit \
-H 'cache-control: no-cache' \
-H 'content-type: multipart/form-data;...
2725 просмотров
schedule
25.05.2024
Как правильно ограничить тип openapi в свойствах?
У меня пока следующее:
Links:
description: Must contain links objects
type: object
properties:
$ref: "#/components/schemas/Link"
ErrorLinks:
allOf:
- $ref: "#/components/schemas/Links"
- properties:
about:...
88 просмотров
schedule
13.11.2023
Сериализуйте вложенные свойства как данные формы с помощью swagger-php
Вот как выполняется пример объекта кодирования в OpenApi https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md
requestBody:
content:
multipart/mixed:
schema:
type: object
properties:...
2416 просмотров
schedule
22.03.2024
Заголовок максимального возраста управления кешем в swagger.yaml
Мой swagger.yaml работает нормально, единственная проблема связана с заголовком управления кешем. Я не вижу этого в ответе. Я определил это, как показано ниже. Не могли бы вы сообщить мне, что с ним не так?
/{empId}/class:
get:
tags:
-...
2277 просмотров
schedule
30.09.2022
Swagger/Open API 3 - необязательные поля (/свойства) в объекте ответа JSON
Я документирую свою конечную точку с помощью Open Api 3.0.2 и создаю интерфейс пользовательского интерфейса swagger из файла yaml. Моя служба принимает ответ мыла и генерирует ответ json. Однако элементы ответа мыла являются необязательными.
JSON...
759 просмотров
schedule
04.03.2024
Пользовательский интерфейс Swagger показывает пример по умолчанию для параметров запроса (вместо предоставленного) после ручной очистки, нажатия кнопки «Отмена» и пробного использования.
У меня есть параметр запроса OpenAPI 3, определенный с помощью in: query , style: form , explode: true и с примерным значением (полное определение в конце).
Я вижу странное поведение со значением примера: при первой загрузке пользовательского...
252 просмотров
schedule
17.05.2024
В чем разница между разделом глобальных определений и разделом компонентов?
В чем разница между глобальным разделом definitions и разделом components в Swagger 2.0?
Я наткнулся на файл YAML определения Swagger, который помечен как swagger: '2.0' . В нем есть один раздел под названием definitions чуть ниже...
649 просмотров
schedule
17.02.2024
Springdoc-openapi возможно ли применить глобальную схему безопасности по умолчанию?
У меня есть следующий SecurityScheme с использованием springdoc-openapi для приложения Java SpringBoot RESTful:
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI()
.components(new...
7822 просмотров
schedule
26.10.2022
Аннотация PHP swagger для нескольких ответов с одним и тем же кодом
В одном из своих методов контроллера я пытаюсь поставить такие аннотации:
* @OA\Response(
* response="404",
* description="Invalid field"
* ),
* @OA\Response(
* response="404",
*...
685 просмотров
schedule
19.04.2024
Добавить политику CORS только для конечных точек Swagger
Я хотел бы добавить cors в swagger.json, но не в конечные точки контроллера. Я могу сделать межсайтовый вызов, когда я добавляю политику cors глобально, используя.
services.AddCors(options => options.AddPolicy("SwaggerCorsPolicy",...
370 просмотров
schedule
28.03.2024
Почему внешние документы отображаются перед серверами в пользовательском интерфейсе Swagger?
У меня есть следующее определение OpenAPI YAML. Раздел externalDocs находится под разделом servers , но отображается перед сервером в предварительном просмотре в редакторе Swagger ( https://editor.swagger.io/ ). Почему это?
openapi: 3.0.0...
217 просмотров
schedule
04.02.2024
Как сослаться на ту же схему, что и на свойство?
В моем файле oas.yaml есть следующее:
components:
schemas:
ServiceError:
type: object
properties:
Message:
type: string
description: "The exception message."
ExceptionMessage:
type:...
35 просмотров
schedule
15.12.2023
Как определить такие даты, как 22 января 2020 года, в OpenAPI 2.0?
На данный момент у меня есть:
type: string
format: YYYY-MM-DD
Как я могу сопоставить дату в формате: Jan 22, 2020 ?
Есть ли предопределенный способ или мне нужно создать своего рода регулярное выражение? Можно ли использовать pattern...
35 просмотров
schedule
18.10.2022
Поддерживает ли спецификация Open API 3.0 журналы изменений?
Я использую спецификацию Open API 3.0 для документирования своих API.
Я заметил, что Open API 3.0 имеет атрибут version . Мне было интересно, есть ли у него способ документировать журналы изменений . Или просто использовать атрибут externalDocs ?
43 просмотров
schedule
16.01.2024
Отключить открытую спецификацию API в производственной среде
Я видел аналогичный ответ для Swagger 2.x здесь - Как отключить swagger-ui в производстве , поэтому мне было интересно, есть ли что-то подобное, что я мог бы сделать и для открытого API? Я пробовал что-то вроде:
@Configuration...
83 просмотров
schedule
26.02.2024
Как использовать плагин Swagger maven codegen с openapi 3.0 (Java + Spring Boot 2.2.4)
У меня есть API, который я пытаюсь переписать, который использует старый swagger-maven-codegen 2.3.1 с устаревшей версией Spring 1.5.9. Я вижу, что когда я запускаю mvn package или mvn install , плагин генерирует интерфейсы, которые реализуют все...
269 просмотров
schedule
30.10.2022
