Я создаю документацию с помощью Redoc в Springboot и хочу вызывать разделы из html-файлов вместо того, чтобы писать все в файле yaml.
это пример в файле yaml:
tags:
- name: Description
description: |
<p>This is the <strong>Description</strong>of the API.</p>
Есть ли способ вызвать абзац из html-файла, поскольку иногда это могут быть длинные абзацы, и, возможно, я мог бы использовать какой-нибудь дизайн с помощью CSS.






Вы можете рассмотреть возможность использования свойства 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
some text about my api using CommonMark syntax described by OpenAPI
src: Синтаксис CommonMark