Slate和Swagger在什么场景下搭配使用？
In what scenario would Slate and Swagger be used together?
来自 我看过
Swagger and Slate serve two different purposes. Swagger is an attempt at a standardized way of describing a RESTful API.
Slate, on the other hand is a pretty theme for writing nice API docs.
它进一步指出
The two are not mutually exclusive
Ideally, one should generate your slate documentation from your Swagger API description
我有点困惑。为什么我已经有了 Swagger UI like so.
还需要 slate
我还需要“记录”什么？我真的在问，因为正如我所说，我对它们的用途有点困惑。
在为新 API 创建文档时，有几件事值得一提。
Swagger 提供了一个非常好的图形界面来探索 API 的端点，但还有其他内容应包含在您的文档中，包括（但不限于）：
- 身份验证方法（OAuth/JWT、基本身份验证、Cookie/Session、Apikey/token）
- 日期输出的日期格式 + 时区
- Filtering/pagination/selecting/sorting API
设置
- 存在哪些环境（通常是测试、pre-production 和生产），包括它们的差异。
- 错误处理，包括错误代码、异常类型和日志记录
- 您的 API
的潜在速率限制
- 使用您的 API
的条款和条件
来自
Swagger and Slate serve two different purposes. Swagger is an attempt at a standardized way of describing a RESTful API.
Slate, on the other hand is a pretty theme for writing nice API docs.
它进一步指出
The two are not mutually exclusive Ideally, one should generate your slate documentation from your Swagger API description
我有点困惑。为什么我已经有了 Swagger UI like so.
还需要 slate我还需要“记录”什么？我真的在问，因为正如我所说，我对它们的用途有点困惑。
在为新 API 创建文档时，有几件事值得一提。
Swagger 提供了一个非常好的图形界面来探索 API 的端点，但还有其他内容应包含在您的文档中，包括（但不限于）：
- 身份验证方法（OAuth/JWT、基本身份验证、Cookie/Session、Apikey/token）
- 日期输出的日期格式 + 时区
- Filtering/pagination/selecting/sorting API 设置
- 存在哪些环境（通常是测试、pre-production 和生产），包括它们的差异。
- 错误处理，包括错误代码、异常类型和日志记录
- 您的 API 的潜在速率限制
- 使用您的 API 的条款和条件