Есть ли способ вызвать внешний HTML-код в файл yaml?

Я создаю документацию с помощью Redoc в Springboot и хочу вызывать разделы из html-файлов вместо того, чтобы писать все в файле yaml.

это пример в файле yaml:

tags:
- name: Description
description: |
<p>This is the <strong>Description</strong>of the API.</p>

Есть ли способ вызвать абзац из html-файла, поскольку иногда это могут быть длинные абзацы, и, возможно, я мог бы использовать какой-нибудь дизайн с помощью CSS.

Улучшение производительности загрузки с помощью Google Tag Manager и атрибута Defer
Улучшение производительности загрузки с помощью Google Tag Manager и атрибута Defer
В настоящее время производительность загрузки веб-сайта имеет решающее значение не только для удобства пользователей, но и для ранжирования в...
Введение в CSS
Введение в CSS
CSS является неотъемлемой частью трех основных составляющих front-end веб-разработки.
Как выровнять Div по центру?
Как выровнять Div по центру?
Чтобы выровнять элемент <div>по горизонтали и вертикали с помощью CSS, можно использовать комбинацию свойств и значений CSS. Вот несколько методов,...
Навигация по приложениям React: Исчерпывающее руководство по React Router
Навигация по приложениям React: Исчерпывающее руководство по React Router
React Router стала незаменимой библиотекой для создания одностраничных приложений с навигацией в React. В этой статье блога мы подробно рассмотрим...
Система управления парковками с использованием HTML, CSS и JavaScript
Система управления парковками с использованием HTML, CSS и JavaScript
Веб-сайт по управлению парковками был создан с использованием HTML, CSS и JavaScript. Это простой сайт, ничего вычурного. Основная цель -...
Toor - Ангулярный шаблон для бронирования путешествий
Toor - Ангулярный шаблон для бронирования путешествий
Toor - Travel Booking Angular Template один из лучших Travel & Tour booking template in the world. 30+ валидированных HTML5 страниц, которые помогут...
0
0
52
1
Перейти к ответу Данный вопрос помечен как решенный

Ответы 1

Ответ принят как подходящий

Вы можете рассмотреть возможность использования свойства externalDocs.

Это свойство позволяет вам определить URL-адрес, по которому размещается документация по API.

openapi: 3.0.3
info:
  title: my api
  version: 1.0.0
externalDocs:
  description: a link to my external documentation for this api
  url: https://developer.myapi.com
servers: []
paths: {}
components: {}

Кроме того, вы можете ссылаться на внешние документы с уценкой, используя $ref для описаний. Это может быть хорошим способом экстернализации и управления всеми вашими описаниями. Этот метод можно использовать для любого свойства description в документе описания OpenAPI.

openapi: 3.0.3
info:
  title: my api
  version: 1.0.0
servers: []
paths: {}
components:
  schemas:
    my_schema:
      description:
        $ref: './docs/my_schema_docs.md
документы/my_schema_docs.md
some text about my api using CommonMark syntax described by OpenAPI

src: Синтаксис CommonMark

Другие вопросы по теме