itsalb3rt / afterman

🌕 Create beutiful docs in markdown and HTML from postman collection

Afterman

Export beautiful docs in Markdown and HTML from postman collection

• 👻 No Backend
• 🔧 No configuration
• 🔥 Customize the output of your documentation (Include Dark mode)
• 🎉 Only HTML, CSS and Javascript (Quasar Framework power)

Note: The tool covers the basic options of a collection, variables, description, headers, body, routes, as needs arise more things will be added.

Main view

Table of content

• Rules
• Get started
• Docker
• Tools for build this Web App

Rules

The collection must be exported in version 2.1 and the requests must be organized in folders.

After this there is nothing else! 😄

---

Get started

$ git clone https://github.com/itsalb3rt/afterman.git
$ cd afterman

Install the dependencies

$ npm install

Start the app in development mode (hot-code reloading, error reporting, etc.)

$ quasar dev

Build the app for production

$ quasar build

---

Docker

$ docker build -t afterman .

$ docker run -d --name afterman -p 8000:80 --rm afterman

We should now be able to access the application on http://localhost:8000

---

Tools

Made with the ❤️ and of course with these great tools

• Quasar Framework
• QMarkdown extension
• UniqId
• Turndown

afterman's Issues

Hide empty cards when not data set

Is your feature request related to a problem? Please describe.
Hide empty cards mark by red arrow

Describe the solution you'd like
Check the data object for check if empty.

Describe alternatives you've considered
NONE

Additional context
NONE

Make table and body elements collapsible

Is your feature request related to a problem? Please describe.
The API at startup does not need to show as much detail

Describe the solution you'd like

2 options (HTML)
1 - Inject javascript to add this feature
2 - Add a static javascript file that can be downloaded along with the main file

At Markdown I can't think how

Describe alternatives you've considered
None

Additional context
None

Set favicon

Is your feature request related to a problem? Please describe.
Use the main icon like favicon

Describe the solution you'd like
Use the project main image.

Describe alternatives you've considered
NONE

Additional context
NONE

Use uglify plugin instead of "immutable" string function for HTML toggle content function

Is your feature request related to a problem? Please describe.
Use modern solution for prevent webpack transpilation of necessary function for final documentation page.

// src/assets/js/TableOfContentUtil.js
/**
 * Prevent webpack transpilation
 */
const inmutableToggleContent = `
window.onload = function () {
  window.toggleContent = function (idEl, iconContainer) {
    const content = document.querySelector('#' + idEl)

    if (content.classList.contains('hide')) {
      iconContainer.textContent = '▼'
      content.classList.add('show')
      content.classList.remove('hide')
    } else if (content.classList.contains('show')) {
      iconContainer.textContent = '►'
      content.classList.add('hide')
      content.classList.remove('show')
    } else {
      content.classList.add('show')
    }
  }
}
`

Describe the solution you'd like
Use this plugin:
https://www.npmjs.com/package/uglifyjs-webpack-plugin

Following the quasar documentation:
https://quasar.dev/quasar-cli/handling-webpack

https://forum.quasar-framework.org/topic/5151/solved-how-to-add-a-webpack-plugin-and-require-file

Describe alternatives you've considered
NONE

Additional context

Add project/company logo or image

Possibility of adding a logo of the project or company.

• The logo position must be configurable
• Positions can be header, footer.
• Be able to choose where it appears and where it does not appear.
• That the logo is downloaded along with the HTML or Markdown

You may have to find a way for documentation downloads to be made in zip.

TypeError: Cannot read property 'forEach' of null

Is your feature request related to a problem? Please describe.

Error in render: "TypeError: Cannot read property 'forEach' of null" after import any collection.

afterman/src/components/RequestUrl.vue

Line 21 in 81d965d

urlVars.forEach(element => {

View Details:

Describe the solution you'd like
Apply fix according to what was discussed.

Describe alternatives you've considered
NONE

Additional context
NONE

Error on missing URL on request

Description

When any request not have the URL set, the app return an error for try access to undefined property;

Cannot read property 'toString' of undefined" RequestBody.vue

Is your feature request related to a problem? Please describe.
When import a collection with any request with empty body the console say:

[Vue warn]: Error in render: "TypeError: Cannot read property 'toString' of undefined"

Describe the solution you'd like
check if the function receives a string.

    parseBody (body) {
      if (body) {
        return body.toString()
      }
      return ''
    },

Describe alternatives you've considered
Or

    parseBody (body) {
      if (typeof body === 'string') {
        return body.toString()
      }
      return ''
    },

Additional context
NONE

import is not working

firstly,
thank you for your great project!!

critical issue is here.
to import collection 2.1 v json file is not working.

endor.a6ddb3d8.js:7 TypeError: Cannot read property 'forEach' of undefined
    at 3.76a98802.js:1
    at Array.forEach (<anonymous>)
    at a.tableOfContent (3.76a98802.js:1)
    at tn.get (vendor.a6ddb3d8.js:7)
    at tn.evaluate (vendor.a6ddb3d8.js:7)
    at a.tableOfContent (vendor.a6ddb3d8.js:7)
    at at (3.76a98802.js:1)
    at a.e._render (vendor.a6ddb3d8.js:7)
    at a.n (vendor.a6ddb3d8.js:7)
    at tn.get (vendor.a6ddb3d8.js:7)

Download in Markdown not function

Is your feature request related to a problem? Please describe.
Download in Markdown not function when import a collection with multiple folders.

View Details:

Describe the solution you'd like
Apply fix according to what was discussed.

Describe alternatives you've considered
NONE

Additional context
NONE

Add description folder into App

Is your feature request related to a problem? Please describe.
No description in folder section

Describe the solution you'd like
Iterate the description folder;

"item": [
  {
    "name": "Employees",
    "item": [ // objects...],
    "description": "Employees is a users of the system" // <---- this
  }
]

Describe alternatives you've considered
For this moment no considered any alternative

Additional context

Toggle not work on HTML downloaded

Is your feature request related to a problem? Please describe.
When downloaded an HTML doc and try toggle element this not work and show an error

Describe the solution you'd like
NONE

Describe alternatives you've considered
NONE

Additional context
NONE