2015-02-24 1 views
0

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

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

ответ

1

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

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

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

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

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

 Смежные вопросы

  • Нет связанных вопросов^_^