API には、オブジェクトのリストを記述する必要がある場所がたくさんあります。各オブジェクトのキー/構造は同じですが、値は異なります。元の構造の元の型、説明などをすべて保持しながら、データ構造の各インスタンスの値を微調整するにはどうすればよいですか?
たとえば、次のデータ構造がある場合Restaurant
# Data Structures
## Restaurant (object)
+ restaurant_name: McDonald's (string, required) - The name of this restaurant
+ years_of_operation: 54 (number, required) - The number of years since established
Restaurant
次に、次のように GET 応答でいくつかの をインスタンス化するとします。
### List all restaurants [GET /restaurants]
+ Response 200 (application/json)
+ Attributes
+ data (array)
+ (Restaurant)
+ (Restaurant)
+ restaurant_name: Bob Evans
+ years_of_operation: 23
+ (Restaurant)
+ restaurant_name: Eataly
+ years_of_operation: 16
JSON 本文は次のようになります ( years_of_operation
Bob Evans と Eatly が数値になっていることに注意してください)
レンダリングされたドキュメントにはこれのみが表示されます (Bob Evans と Eatly のrestaurant_name
説明years_of_operation
は現在欠落しています)。
私は、MSON がそれらの記述と型定義を引き継ぐと考えていました。それ以外の場合は、データ構造が使用されているすべての場所で説明 (または型、要件など) を更新する必要があります... しかし、これは MSON が解決するはずの問題の一種であるという印象を受けました。私は何かばかげたことをしていますか?
そのレポが貢献してから長い時間が経ったので、 githubの問題に加えてここに投稿しています