2016-10-10 9 views
0

は、私は次のルートがあるとします。スワッガードックに可能な値のリストを追加するにはどうすればよいですか?

paths: 
    /data: 
    get: 
     summary: Get list of securities based on filter 
     parameters: 
     - name: market 
      in: query 
      description: Filter securities by market id, default ```all``` 
      type: string 
      default: all 

は、どのように私は、これに使用できる値のリストを追加することができますか?

これもサポートされていますか? enumフィールドが表示されますが、いずれのパラメータにも追加するとエラーが発生します。

答えて

2

enumです。パラメータとプロパティにはenumの値のリストを指定できます。例は次のとおりです。

--- 
swagger: '2.0' 
info: 
    version: 0.0.0 
    title: Simple API 
paths: 
    /data: 
    get: 
     summary: Get list of securities based on filter 
     parameters: 
     - name: market 
      in: query 
      description: Filter securities by market id, default ```all``` 
      type: string 
      default: all 
      enum: 
      - all 
      - market1 
      - market2 
     responses: 
     200: 
      description: OK 

出力を表示するには、上にコピーして貼り付けることができます。

+0

もちろん誰か他の人がそれを投稿すると動作します。/ btw、私はenumを実行するとUIに表示されると思いますか? – iCodeLikeImDrunk

+0

はい、swagger-editorとswagger-uiはどちらも 'enum'をサポートしています。値リストはこれらのツールに表示されます。 – Wilson

関連する問題