REST API设计指南一致性测试

时间:2017-09-19 08:28:10

标签: rest api testing swagger design-guidelines

鉴于REST接口的正式规范 - 例如Swagger 2.0文件 - 我想在设计时针对接口本身的一组简单的预定义设计指南进行测试。指南由强制(必须)和非强制(SHOULD,COULD)语句组成,其中只需要强制执行MUST。

事实:

  • 编写API和相应的Swagger文件的人不是REST专家,尽管他们应该应用上面提到的设计规则但他们不会完全 - 至少
  • 很多Swagger文件,所以我需要一个自动的 用于此目的的工具。不喜欢任何技术或编程语言
  • 验证规则可能会在未来发生变化

示例:

要强制执行的规则:REST API的URI不得包含单词" process"

测试用例n.1

# YAML Swagger to be tested
[...]
paths:
   /process_user/{userId}:
       [...]

# --> Outcome of test against rule: failed

测试用例n.2

# YAML Swagger n.2 to be tested**:
[...]
paths:
   /user/{userId}:
       [...]

# Outcome of test against rule**: passed

您知道有任何工具可以完成这项工作吗?

1 个答案:

答案 0 :(得分:1)

为方便社区发布此信息:用户Samuel_vdc在Zalando发现了一个名为Zally的有趣项目,它是一个“API Linter”,并且在当前的艺术状态下验证了一组硬编码的验证规则( Zalando的官方指南)

有趣的是 - 在Zally引入对用户提供的规则集的支持之后 - 这些规则将如何正式构建......