Comments (6)
Assuming you are talking about including the request body.
The documentation should add the request body. Please check the input JSON file.
Input:
Markdown documentation:
HTML documentation:
Unfortunately, I could not simulate the response, but it will work fine.
Docgen version: v2.3
Support postman collection version > 2.1
Thanks for the appreciation!
from docgen.
I believe what you demonstrated is that the request body is shown for the “main” request, but they are not shown for the “examples” for the request. I can send more screen shots later this morning when I’m at my computer, if that helps.
I also need to get more familiar with better ways of organizing my collection. I’m using Postman “requests” to define specific routes of my API, rather than define many requests with different examples for the same route, if that makes sense..
from docgen.
Examples show up in the documentation as "responses" not as "examples" as they're named in Postman.
from docgen.
Please use the latest v3.0.0-rc
curl https://raw.githubusercontent.com/thedevsaddam/docgen/v3/install.sh -o install.sh && sudo chmod +x install.sh && sudo ./install.sh
Don't forget to provide feedback and close the opened issue.
from docgen.
I will try this today. Thank you!
from docgen.
This is great @thedevsaddam. I have some other suggestions, but I will put them in a new issue.
from docgen.
Related Issues (20)
- html response body tags coverted to html character entities
- Add feature pathname server
- Add Bearer Token
- Linux arm
- Greater/less than Characters
- Refused to execute inline script because it violates the following Content Security Policy directive HOT 6
- Do not sort the collections in lexical order by default. HOT 1
- Trouble with maps in maps
- GitHub Action for docgen
- Markdown conversion hangs HOT 1
- Run request button HOT 1
- docgen error when trying to generate the html file from the postman json file HOT 1
- Links to markdown anchors with parenthesis not working HOT 2
- Additional Languages
- Nested Folder Reading Issue HOT 2
- UNABLE TO RUN DOCGEN.EXE ON WINDOWS
- Certain markdown links not working in Gitlab
- 2022/10/02 15:39:48 parsing json filejson: cannot unmarshal string into Go struct field Request.item.item.request.url of type collection.URL HOT 2
- docgen: command not found
- 生成MarkDown在线文档对中文标题无法正常跳转
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docgen.