用swagger做活動數據庫做api文檔

-1

看到這個api documentation，我得到發佈和查詢數據。我明白這是一個與swagger的演示API文檔。

但是真實世界的API文檔會發生什麼？我有demo.api.myawesome.com和api.myawesome. com上使用不同的數據存儲的實際API的文檔？

但是再次深入挖掘，我發現api可以使用swagger libraries自我記錄。這似乎就像api和文檔都使用相同的數據存儲，但情況並非如此。

我在這裏錯過了什麼？

爲什麼不能這樣？如果api具有正確的身份驗證，那麼通過以其他方式通過點擊API無法執行的文檔，您無法完成任何操作。除非您有有效的密鑰，否則您將無法從文檔中創建/刪除。 –

不會污染帶虛擬/測試數據的實時數據。文檔中的數據是測試/演示數據。 –

是的，它當然可以。但這並不是無法完成的原因。不管這是不是一個好主意，完全是另一個問題。 –

從揚鞭網站：

揚鞭是一組規則（換言之，一個規格）描述的REST API的格式。該格式既是機器可讀的，也是可讀的。因此，它可以用於在產品經理，測試人員和開發人員之間共享文檔，但也可以被各種工具用於自動化與API相關的過程。

所以是的，它使用與實際API相同的「後端」。它只是將其可視化，允許您通過Swagger UI與它進行交互。

2017-07-13 19:13:57 CDahn

如果您的意思是Swagger UI - 「嘗試它」按鈕將請求發送到您的規範中host屬性指定的服務器。如果host指定您的生產服務器，請求將發送到生產;如果它指向一個沙箱，「嘗試一下」將使用沙箱。您可能有指向生產的內部使用規範版本以及指向沙箱的公共版本。

請注意，Swagger支持authentication作爲一種確保只有授權用戶（例如具有有效憑證或API密鑰的實際客戶）才能進行API調用的方法。

您可以從規範中省略host以禁用「試用」功能 - 這樣，您仍然可以擁有API文檔，而無需交互式部分。

2017-07-13 19:54:21 Helen

回答