如何同步API藍圖與API源代碼？

我想用PHP開發一個REST Full API。但在開發真正的API之前，我想首先創建藍圖作爲API控制檯的文檔，假設我正在使用swagger或raml來完成此操作。據我的理解，API藍圖和API是不同的源代碼。這意味着如果我改變了API，我還必須更改API藍圖，反之亦然。如何同步API藍圖與API源代碼？

我想知道的是，是否有任何技術/框架/代碼或任何API和API藍圖之間進行同步？

意味着我只需要在一側（在API或藍圖中）進行更改，而不僅僅是同步來更改另一側。

非常感謝。

來源

2016-03-16 Praditha

你看過PhpDoc嗎？ –

我認爲PhpDoc只生成文檔，我想要的就像是大開眼界，那裏有一個API控制檯，所以我和我的團隊可以使用虛擬數據嘗試API。 - CMIIW – Praditha

然後，您很可能需要更新2個地方 –

不幸的是，我們（Apiary）目前實際上並沒有提供API藍圖的任何代碼同步工具。

如果您正在尋找如何從代碼生成API描述的方法，那麼API Blueprint可能不是最佳選擇，因爲我們相信它應該代表API設計生命週期中涉及的每個人之間的合同。這也是我們建立測試工具的原因 - Dredd - https://github.com/apiaryio/dredd

使用Dredd，您可以測試您的API實現與您的藍圖相匹配。如果藍圖是從實施中產生的，那麼沒有什麼意義。

希望澄清。

來源

2016-03-16 08:06:20 Vincenzo

是的，我同意您的意見，如果藍圖是從實施中生成的，則意義不大，因爲實施是指藍圖。 – Praditha

如何同步API藍圖與API源代碼？

回答

相關問題