0
我正在創建如此多的API。我們計劃將其公開發布。有這麼多的API和它的迴應。每個API可以使用多個參數集來調用，並且可能會根據調用參數導致不同的結果集。理想的API文檔應該如何？
我不知道如何用不同的參數記錄所有這些API。
A
回答
1
使用新的api時，我總是檢查哪些文檔易於理解。 我會建議你，如果可能的話，嘗試爲你的API創建一個視頻教程（它是什麼？以及如何使用它？）沒有什麼比視頻更好地解釋一切。
對於書面文檔，請確保您正在詳細闡述可能會影響您的API的所有細微事情。請務必提及您的api的所有限制。很多時候，開發人員忘記了幾件事情，而最終用戶需要很多時間才能找出這種限制。
祝你好運！前進！
相關問題
- 1. 我應該如何爲我的Web服務API生成文檔？
- 2. 我應該如何添加JavaFX的API文檔到Eclipse？
- 3. 如何讓圖書館文檔的所有者管理該文檔的權限？
- 4. 我應該如何存儲記錄應用程序的文檔？
- 5. 如何生成API文檔
- 6. 如何使用API文檔
- 7. 如何生成API文檔
- 8. 如何閱讀API文檔？
- 9. 我想讓我的Android應用程序min API 8.該文檔給我的API 8中不可用的函數。我應該在哪裏看？
- 10. 使用線程，我應該如何處理理想情況下應該按順序發生的事情？
- 11. 理想又該的onPause寫（）
- 12. 我應該如何處理API中的錯誤？
- 13. 我應該如何在我的REST API中處理認證？
- 14. 調用REST API後應該如何處理返回的鏈接？
- 15. iPhone NSURLConnection：如何處理返回的NSData對象？ Google文檔API
- 16. 帶有文檔，源代碼管理和API文檔的RubyGems？
- 17. 如何理解MSDN文檔？
- 18. 如何處理PDF文檔？
- 19. xsd文檔註釋中的xml應該如何轉義？
- 20. HTML文檔的所需標籤應該如何縮進？
- 21. 如何查詢查詢應該包含和子句的文檔？
- 22. 如何註冊iOS Safari應該支持的文檔類型？
- 23. 公開API來管理Office Web應用程序中的文檔
- 24. 變更管理，什麼應該是理想的流程？
- 25. 如何生成Magento的API文檔/文檔？
- 26. MongoDB：如何插入一個文檔，該文檔的值應該通過查詢進行評估？
- 27. 如何解釋JQuery UI的API文檔？
- 28. 我的Swagger文檔（又名Open API）應該定義500個響應代碼嗎？
- 29. 理想的API路線
- 30. 維護文檔管理系統應該走什麼方向？
謝謝你提到限制。我真的很喜歡這一點。我找不到任何我正在尋找的例子，我想我需要找到一種方法。不管怎麼說，還是要謝謝你。 – ChintanThummar