Повторное использование модели ресурсов в виде массива

Я документирую API, и у меня есть 2 очень похожих ответа.

Одним из них является вызов /resource/{id}. Этот ответ возвращает модель ресурса.

Другим вызовом является /resource/search{? Name,category}, который возвращает список ресурсов, поэтому мне нужно вернуть массив модели ресурсов.

Я не могу найти, смогу ли я сделать это. В проектной документации есть нечто похожее на Gists. Но есть две модели Gist и Gist Collection.

Я надеюсь, что объяснил себя.

1 ответ

К сожалению, в данный момент вы не можете ссылаться на одну полезную нагрузку на другую. Причина этого заключается в том, что полезная нагрузка (модель, запрос или ответ) непрозрачна для синтаксического анализатора API Blueprint (и, следовательно, вам не нужно ничего избегать внутри).

Есть планы удовлетворить эту потребность и сделать чертежи более сухими в будущем - см. Вехи встраиваемых активов и черт.

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