Есть ли способ показать «Примерное значение» и «Схему» рядом друг с другом в документации swagger / OpenAPI 3.0?

#swagger #swagger-ui #openapi

#swagger #swagger-ui #openapi

Вопрос:

У меня есть документация swagger, написанная с помощью swagger и OpenAPI 3.0. В сгенерированной документации запроса (а также ответа) «Примерное значение» и «Схема» отображаются в виде вкладок, из которых вы можете выбрать либо одну, либо другую. Вот так:

Вкладки quot;Пример значенияquot; и quot;Схемаquot;

Есть ли способ показать «Примерное значение» и «Схему» рядом друг с другом вместо вкладок, чтобы вы могли видеть оба сразу, когда открываете запрос, не щелкая где-либо? Потому что в противном случае «Схема» легко просматривается, и разработчик может подумать, что «Примерное значение» — это единственная информация, которая у них есть для запроса…

Комментарии:

1. Не из коробки, вам нужно будет раскошелиться и реализовать это самостоятельно. Не стесняйтесь отправлять запрос функции: github.com/swagger-api/swagger-ui/issues

Ответ №1:

Насколько я знаю, прямого способа нет. Но есть обходные пути, которые можно использовать после реализации анализаторов swagger с использованием разных языков программирования.

Комментарии:

1. как бы в целом выглядел обходной путь? Я специально использую его на сервере NodeJS с swagger-jsdoc 4.0.0, swagger-ui-express 4.1.4 и swagger-parser 9.0.1.

2. В основном это реализация каждого из компонентов с использованием NodeJS. Таким образом, вы можете добавить это поле «Пример» в качестве дополнительного поля.