Входные параметры при создании файла HTML?

В настоящее время я работаю с aglio, чтобы сгенерировать спецификации API для нескольких различных сервисных групп. Проблема, с которой я сейчас сталкиваюсь, заключается в том, что я хочу развернуть спецификацию в нескольких средах (для разных групп потребителей), поэтому отображаемые базовые URL-адреса должны быть разными.

Есть ли способ отправить базовый URL для каждого поколения файлов HTML?

1 ответ

Решение

Вы можете использовать функцию включения <!-- include(OtherFile.md) -->,

В моем случае я использую несколько файлов:

  • один файл верхнего уровня (например, V1.md), содержащий метаданные и общее введение в API
  • один файл на ресурс (например, AuthResource.md, UserResource.md), где я документирую только функциональность этого ресурса

В файле верхнего уровня есть оператор включения для каждого файла ресурсов. В Aglio я выбираю только файл верхнего уровня.

В вашем случае вы можете использовать файлы, специфичные для клиента или среды, перед файлом верхнего уровня. Переместите метаданные в пользовательские файлы и включите их в файл верхнего уровня. Затем вы можете отобразить каждый файл для конкретного клиента в HTML.

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