2

I'd like to be able to document the parameters as if they were URL parameters, since I like how that bit of documentation renders a handy table. However, in my API, I would like those paremeters to plug into the JSON body rather than the URL. Is there a way to achieve this?

Eugene
  • 2,946
  • 2
  • 26
  • 30

1 Answers1

0

The dedicated syntax for describing, discussing (and thus also validating) message-body is in the making.

It will be based on the Markdown Syntax for Object Notation, similar to the actual URI Parameters description syntax (eventually these two should converge).

Also see related How to specify an optional element for a json request object and Is it possible to document what JSON response fields are? questions.

Community
  • 1
  • 1
Zdenek
  • 3,653
  • 27
  • 34