REST APIデザインガイドラインコンプライアンステスト

Question

RESTインターフェイスの正式な仕様 - Swagger 2.0ファイル - が、デザイン時に、インターフェイス自体の簡単な事前定義されたデザインガイドラインに対してテストしたいと思います。ガイドラインは必須（MUST）と非必須（SHOULD、COULD）のステートメントから構成され、ステートメントはMUSTのみが実施される必要があります。

事実：APIおよび対応する闊歩ファイルを書き込むこと

• 人々が専門家をRESTされていない、とaltough彼らは、彼らはそれを行うことはありません、上記の設計ルールを適用することになっている - ではない完全に、少なくとも
• スワッガーファイルがたくさんあるので、私はこの目的のために自動 ツールが必要です。

  ルールを強制する：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 

あなたは仕事をすることができます任意のツールを知っていますか？

Answer 1

コミュニティの利便性のためにこれを投稿：ユーザーSamuel_vdcはZalandoによって興味深いプロジェクトはZalandoの公式「APIリンター」で、現在の技術でバリデーションルールのハードコーディングされたセットに対して検証Zallyを、（と呼ばれましたガイドライン）

Zallyがユーザー提供のルールセットのサポートを導入した後で、それらのルールが正式にどのように構成されるかを知ることは興味深いでしょう...