How to place comments in Postman?

Question

How to place comments inside Postman? Specifically in the JSON request body section?

I want to comment-out a particular key or value from the request body so that it is not sent.

Commenting out a JSON key/value pair with // or /* ... */ appears as a styled comment inside Postman:

But sending this request results in server errors such as the below, and it's clear that the commented-out line is being sent as part of the request body:

Unexpected character ('/' (code 47)): maybe a (non-standard) comment? (not recognized as one since Feature 'ALLOW_COMMENTS' not enabled for parser) at [Source: (org.glassfish.jersey.message.internal.ReaderInterceptorExecutor$UnCloseableInputStream); line: 2, column: 6 ]

The JSON spec does not allow comments: Can comments be used in JSON?

I want Postman to strip the commented lines prior to being sent in the request.

Hi, you may have a look at this link: https://stackoverflow.com/questions/244777/can-comments-be-used-in-json?rq=1 — A.Joly, Jul 10 '17 at 08:59
Does this answer your question? [Can comments be used in JSON?](https://stackoverflow.com/questions/244777/can-comments-be-used-in-json) — Henke, Feb 17 '21 at 12:36
There is nothing magic about that body in Postman. It is just plain JSON. So unfortunately - as stated by the accepted answer to [Can comments be used in JSON?](https://stackoverflow.com/a/244858) - the answer is ***No***. A possible workaround is to add a "phony" field to your JSON data, like `"_comment": "comment text goes here...",`. - Of course, the trick to *comment out* some of your JSON data would be to simply change the name of the key that you want to "disable". — Henke, Feb 17 '21 at 12:49

score 25 · Accepted Answer · answered Jul 03 '17 at 12:31

25

You can write documentation and comments using the description section of the requests, collections or folders.

answered Jul 03 '17 at 12:31

Pratik Mandrekar

8,930
3
40
64

24

I just want to disable some code not want to add comments or descriptions..how can I do that? – Mahender Reddy Yasa Jul 23 '18 at 13:25
2

same question as @MahenderReddyYasa – YaserKH Sep 22 '18 at 11:50
2

You can disable code using either a `// ` or a `/** – Pratik Mandrekar Dec 20 '18 at 15:26
3

OP is asking how to stop Postman including commented code in requests, this is the problem. – Marius Mar 05 '21 at 09:39

score 9 · Answer 2 · edited Jun 02 '22 at 16:36

9

A "Comments" option/button is above the send button for every request.

But still, we can't add a comment in the request body, maybe in future, they'll provide this feature.

edited Jun 02 '22 at 16:36

pkamb

30,595
22
143
179

answered Oct 16 '19 at 00:56

Ravinder Reddy Kottabad

496
5
9

Theo · Answer 3 · 2021-05-11T19:16:37.663

7

Finally, since Postman v8.3.0 you can do this in your collections pre-request script:

// Strip JSON Comments
if (pm?.request?.body?.options?.raw?.language === 'json') {
    const rawData = pm.request.body.toString();
    const strippedData = rawData.replace(
        /\\"|"(?:\\"|[^"])*"|(\/\/.*|\/\*[\s\S]*?\*\/)/g,
        (m, g) => g ? "" : m
    );
    pm.request.body.update(JSON.stringify(JSON.parse(strippedData)));
}

This strips all comments from the json and sets the current body to the cleaned one, there are more examples for other body types (GraphQL, URL Encoded, Form Data) in the original github post this code is based from.

edited May 11 '21 at 19:16

answered May 10 '21 at 08:20

Theo

1,584
1
17
39

2

This works great! But I needed to additionally update header: `pm.request.upsertHeader({key: 'Content-Type', value: 'application/json'});`. It seems like updating body resets content type to plain text. – ImSpeakEnglish Mar 26 '22 at 13:24

score 4 · Answer 4 · edited Jun 02 '22 at 16:22

4

I checked with GitHub where Postman has their feature requests and bugs tracked, Link here:

Feature request: Raw body editor JSON comment #3358
https://github.com/postmanlabs/postman-app-support/issues/3358

You can go and add comments there so that this feature would be considered for their next release. Also, I found out that you can copy and paste  to make a comment.

edited Jun 02 '22 at 16:22

pkamb

30,595
22
143
179

answered Apr 15 '19 at 12:27

Subdex

71
7

score 2 · Answer 5 · answered Nov 23 '20 at 01:51

It has been done by Script
https://community.postman.com/t/request-body-should-be-able-to-be-commented/8288

Pre-request Script created an object and convert it to a string then expose it

object = {
   // product: “{{displayName}}”,
   price : “15.5”
}
pm.environment.set(“object”, JSON.stringify(object));

Request Body called the variable object

{{object}}

score 0 · Answer 6 · answered Feb 15 '22 at 05:50

0

In Postman v9.13.0 you can do so using block comments

answered Feb 15 '22 at 05:50

abadgujar

38
7

score -1 · Answer 7 · edited Jun 02 '22 at 16:23

-1

Not the actual question's answer, but this addresses the highly upvoted comment below the question:

I just want to disable some code not want to add comments or descriptions..how can I do that? – Mahender Reddy Yasa

Ignoring the comment validation and sending request is now working for me in latest postman 7.7.3 64 bit version of windows.

edited Jun 02 '22 at 16:23

pkamb

30,595
22
143
179

answered Sep 26 '19 at 12:38

Praveen

791
6
15

3

There is a clear error shown on the side. Please verify that. – Shawn Mar 03 '20 at 14:30
4

@Shawn Yes, Ignoring that validation and sending request will work. In above case `Description` will not send to server. – Praveen Mar 03 '20 at 15:38
1

Worked here with "//" – Fábio Nov 22 '21 at 17:26

How to place comments in Postman?

7 Answers7