Coder Social home page Coder Social logo

Comments (6)

thedevsaddam avatar thedevsaddam commented on September 23, 2024

Assuming you are talking about including the request body.

The documentation should add the request body. Please check the input JSON file.

Input:

Screenshot 2020-05-07 10 31 09

Markdown documentation:

Screenshot 2020-05-07 10 31 59

HTML documentation:

Screenshot 2020-05-07 10 31 26

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.

mnich0ls avatar mnich0ls commented on September 23, 2024

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.

mnich0ls avatar mnich0ls commented on September 23, 2024

The examples for a request:
image
image

Examples show up in the documentation as "responses" not as "examples" as they're named in Postman.

from docgen.

thedevsaddam avatar thedevsaddam commented on September 23, 2024

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.

mnich0ls avatar mnich0ls commented on September 23, 2024

I will try this today. Thank you!

from docgen.

mnich0ls avatar mnich0ls commented on September 23, 2024

This is great @thedevsaddam. I have some other suggestions, but I will put them in a new issue.

from docgen.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.