提供人类可读的文档

提供人类可读的文档，客户开发人员可以使用这些文档来理解您的 API。

如果您如上所述使用 prmd 创建架构，您可以使用prmd doc轻松地为所有端点生成 Markdown 文档。

除了端点详细信息外，还提供包含以下信息的 API 概述：

• 身份验证，包括获取和使用身份验证令牌。
• API 稳定性和版本控制，包括如何选择所需的 API 版本。
• 常见的请求和响应头。
• 错误的序列化格式。
• 将 API 与不同语言的客户端一起使用的示例。