

JSONデータの仕様書を書く場合、どのようなフォーマットやツールを使って仕様書を書くことが一般的なのでしょうか？  
できれば、サンプルのJSONファイルから、ある程度仕様書の雛形を自動生成できるツールを教えてもらえると嬉しいです。


CC BY-SA 4.0
2018-09-26T11:27:31.040
48729
2018-09-26T13:46:30.100
22748
question
json
JSONデータの仕様書を書く方法とツール


JSONの仕様を定めるものとして「 **JSON Schema**
」が有名です。これはJSONが満たすべき条件（何とかというフィールドは文字列が入っていなければいけないとか）を記述することができるフォーマットで、JSON
Schema自体もJSONで記述されます。

JSON
Schema自体もJSONで記述することになるため、人間が読んで理解するためのものというよりは機械が読むものという位置づけとなり、お求めの「仕様書」とは少し違うかもしれません。一応、人間が読めるようなドキュメントをJSON
Schemaから生成しようという試みも存在するようです（[参考1](https://groups.google.com/forum/#!topic/json-
schema/PWfDH0ibS4c)，[参考2](https://github.com/gratex/schema2doc)）。

入力されたJSONがJSON Schemaに合致するかどうかを検査できるライブラリも存在します。「JSON Schema
generator」などの検索ワードで調べればJSON SchemaをJSONのサンプルから生成するツールも発見できます。


CC BY-SA 4.0
2018-09-26T13:03:47.877
48733
2018-09-26T13:46:30.100
2018-09-26T13:46:30.100
30079
30079
48729
answer