提供人类可读的文档

提供人类可读的文档让客户端开发人员可以理解你的API。

如果你用prmd创建了一个概要并且按上述要求描述，你可以很容易的生成所有结节使用prmd doc的Markdown文件。

除此之在详细信息的结尾，提供一个关于如下信息的API摘要:

• 验证授权,包含获取及使用验证tokens.
• API 稳定性及版本控制, 包含如何选择所需要的版本.
• 一般的请求和响应头信息.
• 错误信息序列格式.
• 不同语言客户端使用API的例子.