Change <!-- RESPONSE --> to // RESPONSE inside a code block comment

[diegoulloao]

There is a problem when documenting an example response.

Actually works like:

<!-- RESPONSE -->
{
... data
}
<!-- ENDRESPONSE -->

But the problem with that is looks ugly and not readable in Insomina Docs tab, without format.

I suggest change it to:

// RESPONSE
{
    ... data
}

all inside a codeblock.

In that form the markdown format preserves in the Insomnia doc tab and will still appear at the right panel as response example in the generated documentation.

[jozsefsallai]

I'll take this into consideration because I do agree that the current way to do it looks quite ugly! Thank you :)

[mperezcorrales]

Hi, I was reading this issue and was wondering how you add the response to the documentation? I don't know if when exporting the data from the Insomnia client you could add the response preview. Thanks for the help.

[devhammed]

Hello there!

I am thinking we can leverage the language tag support of markdown code blocks for this:

And I have actually implemented it:

[diegoulloao]

@devhammed much better!

[devhammed]

Hello everyone, I have just created the pull request at #51 ... hopefully, @jozsefsallai will be able to merge it ASAP.

[devhammed]

Hello everyone!

If you are using the plugin, you can now upgrade to use the new example response format.

Documenting:

Insomnia Rendering:

Documenter Rendering:

[jeffersonfelixdev]

I think it is a good idea to add it in docs.

[devhammed]

I think it is a good idea to add it in docs.

Is it not already?