提供一般人可讀的文件

提供一般人可讀的文件，讓開發者理解您的 API。

若您以前述 prmd 建立大綱，您可以用 prmd doc 輕鬆的產生所有端點的 Markdown 文件。

除了端點的詳細內容，也應提供含以下資訊的 API 概觀：

• 認證方法，包含取得與使用 token。

• API 穩定性與版本，包含如何選擇想要的 API 版本。

• 一般性的需求與回應標頭。

• 錯誤序列化 (serialization) 格式。

• 不同語言的客戶端 API 使用範例