如何让Postman/Docgen生成的API文档展示接口响应？

Hey there! Let's sort out why your docgen-generated API docs aren't displaying responses. The core issue usually boils down to making sure Postman has saved response data for each request, and that docgen is configured to pull that data in. Here's a step-by-step breakdown to fix this:

Docgen can't display what Postman doesn't store. For every request you want to show a response for:

• Send the request in Postman to get a valid response.
• In the response panel, click the floppy disk icon labeled Save Response.
• Name the response something clear (like "200 OK - Successful Request") and confirm it saves under the request's "Responses" folder.
• Double-check: Expand your collection in Postman, and each target request should have a "Responses" section with your saved data inside.

Before feeding it to docgen, export your Postman Collection as a v2.1 JSON file:

1. Click the three dots on your collection > Export.
2. Choose "Collection v2.1" and save the file.
3. Open the JSON file and search for the responses key under any request. You should see saved data like body, status, and headers here. If this field is missing, go back to Postman and re-save the response for that request.

Most docgen tools require a specific flag to pull in response data. For example:

• If using postman-to-markdown, add the --include-responses flag to your command:

  postman-to-markdown -c your-collection.json -o api-docs.md --include-responses
  

• For other tools (like postman-docgen), check the local help (run docgen --help) to find the right parameter—look for terms like --responses, --include-all, or similar.

• Don't confuse "Save Response" with "Save as Example": Postman's "Example" feature is for custom request/response pairs, while docgen typically pulls from the auto-saved "Responses" you create after sending a live request.
• Batch save for large collections: Use Postman Runner to execute all your requests at once. After the run finishes, select all requests in the results panel, right-click, and choose "Save Responses" to bulk-add data.

内容的提问来源于stack exchange，提问作者Shashika Virajh