Help us understand the problem. What is going on with this article?

apiblueprint のパラメーター内の記述で "-"(ハイフン) を使うとき

More than 3 years have passed since last update.

APIBlueprint を試しがてら使っているのですが、-(ハイフン)が入った値をパラメーターのサンプル値として設定するときに思ったような挙動をしなかったのでメモします。

+ Parameters 
  + sample1: sample1_val (string, optional) - サンプル1
  + sample2: sample2-val (string, optional) - サンプル2

みたいな記述をしたときに、 sample2 の方がなぜか reuired で出力されてしまいます。

これはどうも ハイフン が原因のようで、ハイフン を使うときは `(バッククォート)で括らないといかんみたいです。

なので、

+ Parameters 
  + sample1: sample1_val (string, optional) - サンプル1
  + sample2: `sample2-val` (string, optional) - サンプル2

とやれば大丈夫です。

リファレンスに書いてありそう。

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away