Как синхронизировать API Blueprint с исходным кодом API?

Question

Я хочу разработать полный API REST с помощью PHP. Но прежде чем я разработаю настоящий API, я хочу создать Blueprint сначала как документацию с помощью консоли API, скажем, я использую swagger или raml для этого. Насколько я понимаю, API Blueprint и API - это разные исходные коды. Это означает, что если я изменил API, я также должен был изменить план API или наоборот.

Что я хочу знать, есть ли какие-либо технологии/рамки/код или что-нибудь, чтобы синхронизировать API с API-планом?

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

Большое спасибо.

Answer 1

К сожалению, мы (Apiary) на самом деле не предлагаем какой-либо инструмент синхронизации кода на данный момент для API Blueprint.

Если вы ищете способ создания описания вашего API из кода, тогда API Blueprint, вероятно, не лучший выбор, так как мы считаем, что он должен представлять собой контракт между всеми участниками жизненного цикла API-интерфейса. Это также является причиной того, что мы создали инструмент для тестирования - Dredd - https://github.com/apiaryio/dredd

С Dredd вы можете протестировать свою реализацию API, соответствующую вашему проекту. Это не имело бы большого смысла, если бы проект был сформирован из реализации.

Надеюсь, он уточнит.