2017-09-19 42 views
1

給定一個REST接口的正式規範 - 例如Swagger 2.0文件 - 我想在設計時對照接口本身的一組簡單的預定義設計準則進行測試。準則由強制性(MUST)和非強制性(SHOULD,COULD)聲明組成,其中只需執行MUST。REST API設計準則一致性測試

事實:

  • 人寫的API和相應揚鞭文件沒有REST專家和altough他們應該運用上述設計規則,他們也不會做 - 不完全,至少
  • 大量的Swagger文件,所以我需要一個自動的 工具來達到這個目的。無偏好的任何技術或編程語言
  • 驗證規則可能會在未來改變

例子:

規則加以執行:沒有一個REST API的URI必須包含單詞「過程」

測試用例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

張貼這對社區的便利性:用戶Samuel_vdc發現Zalando一個有趣的項目叫Zally,這是一個「API短絨」,在藝術的當前狀態驗證對一個硬編碼組驗證規則(Zalando官指導方針)

知道 - Zally引入對用戶提供的規則集的支持後 - 這些規則將如何正式構建......