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

Question

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

Что я хочу знать, есть ли какие-либо технологии / фреймворк / код или что-нибудь для синхронизации между API и Blueprint API?

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

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

Answer 1

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

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

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

Надеюсь, это проясняет.