Anything tool to document JSON


#1

I’m wondering is there any way to document JSON like swagger @ApiProperty annotation.
I’d like to add a description of each field in my example JSON.

example: !include my-request.json


#2

We do our documentation in a separate JSON schema file.
For each property we want to document we have an entry.
The below example is for a property called lastReportTime

"lastReportTime":{
	"type":"string",
	"format":"date-time",
	"description":"The last time the device reported in on this feed"
}

In the raml API we then reference both the schema and the sample JSON. The downside is it requires the user to look at two places for the information, and if your schema starts getting complicated then it is harder for a user to read.