在什么情况下Slate和Swagger会一起使用?

时间:2019-05-26 15:27:35

标签: swagger documentation swagger-ui api-doc

this question中我已经看到

  

Swagger和Slate有两个不同的用途。 Swagger是一种尝试以标准方式描述RESTful API的尝试。

     

另一方面,Slate是编写漂亮的API文档的漂亮主题。

它进一步指出

  

两者不是互斥的   理想情况下,应该从您的Swagger API描述生成您的Slate文档

我有点困惑。当我已经拥有Swagger UI like so时,为什么还要选择板岩。

“文档”还需要什么?我确实是在问,因为正如我说的那样,我对它们的用法有些困惑。

1 个答案:

答案 0 :(得分:1)

为新API创建文档时,有几件事值得一提。

Swagger提供了一个非常不错的图形界面,用于探索API的端点,但是您的文档中还应该包含其他内容,包括(但不限于):

  1. 身份验证方法(OAuth / JWT,基本身份验证,Cookie /会话,Apikey /令牌)
  2. 日期输出和时区的日期格式
  3. API的过滤/分页/选择/排序设置
  4. 存在哪些环境(通常是测试,预生产和生产),包括它们之间的差异。
  5. 错误处理,包括错误代码,异常类型和日志记录
  6. 您的API的潜在速率限制
  7. 使用API​​的条款和条件