hoppscotch / hopp-doc-gen Goto Github PK

pw-cli generate <path to collection> error.

collection

[
    {
      "name": "Demo",
      "folders": [
        {
          "name": "folder1",
          "requests": [
            {
              "url": "http://127.0.0.1:1984",
              "path": "/first-folder1",
              "method": "GET",
              "name": "Inside sub-folder",
              "collection": 2
            },
            {
                "url": "http://127.0.0.1:1984",
                "path": "/second-folder1",
                "method": "GET",
                "name": "Inside sub-folder",
                "collection": 2
              }
          ],
          "folders": []
        },
        {
            "name": "folder2",
            "requests": [
              {
                "url": "http://127.0.0.1:1984",
                "path": "/first-folder2",
                "method": "GET",
                "name": "Inside sub-folder",
                "collection": 2
              },
              {
                "url": "http://127.0.0.1:1984",
                "path": "/second-folder2",
                "method": "GET",
                "name": "Inside sub-folder",
                "collection": 2
              }
            ],
            "folders": []
          }
      ],
      "requests": [
        {
          "url": "http://127.0.0.1:1984",
          "path": "/outside",
          "method": "GET",
          "name": "Outside sub-folder",
          "collection": 2
        }
      ]
    }
  ]

actual output

command

hdg generate -s example.json

output

# API Documentation

## Demo
### Outside sub-folder
 - url: http://127.0.0.1:1984
 - path: /outside
 - method: GET
---

<br/>

expected output

# API Documentation

## Demo
### Outside sub-folder
 - url: http://127.0.0.1:1984
 - path: /outside
 - method: GET
---
### folder1
#### Inside sub-folder
 - url: http://127.0.0.1:1984
 - path: /first-folder1
 - method: GET
---
#### Inside sub-folder
 - url: http://127.0.0.1:1984
 - path: /second-folder1
 - method: GET
---
### folder2
#### Inside sub-folder
 - url: http://127.0.0.1:1984
 - path: /first-folder2
 - method: GET
---
#### Inside sub-folder
 - url: http://127.0.0.1:1984
 - path: /second-folder2
 - method: GET
---

<br/>

i got,
postwoman-cli>postwoman-cli get
'postwoman-cli' is not recognized as an internal or external command,
operable program or batch file.

Consider adding some options for the users in the generate command?

I was wondering something like:

generate <path>                 Create API documentation
generate [options] <path>

Options:
  -o, --output-path <path>       The documentation markdown file output path
  -u, --update <path>            Update de documentation markdown file
  -n, --no-install               Skip npm install and create only the markdown file
  -r, --request-buttons          Add a request button for each request

1. -o, --output-path <path>
   Now the default value of path is docs/README.md. Would be nice if we could replace it for some other path.

2. -u, --update
Now if we have a docs folder or a package.json the process is stoped. As the api evolves is common the need to update the documentation. With this option set, the user could just update the existing markdown file.

3. -n, --no-install
   It is great that the cli create all the doc website and npm install and so on. But in some cases it is more usefull to gerenerate just the plain markdown.

4. -r, --request-buttons
   Would be nice if in the generated website we could run the requests and easily test the apis.

todo:

hdg generate <options>

• -o, --output-path <path>
• update existing doc after response from the user
• -n, --no-install
• -r, --request-buttons
• tests

add few comments to start work on that

Describe the solution you'd like
send api requests and report status based on postwoman-collection.json file

Describe alternatives you've considered
create a new command send or test to send and report the status of the requests

Aditional context

$ pw-cli send path/to/postwoman-collection.json

regres.in # collection name
┌──────────────────────────────────────────────────┬───────────────┬───────────────┐
│ url                                              │ method        │ status        │
├──────────────────────────────────────────────────┼───────────────┼───────────────┤
│ https://reqres.in/api/users                      │ GET           │ 200           │
├──────────────────────────────────────────────────┼───────────────┼───────────────┤
│ https://reqres.in/api/users/api/users            │ POST          │ 201           │
├──────────────────────────────────────────────────┼───────────────┼───────────────┤
│ https://reqres.in/api/users/api/users/999        │ GET           │ 200           │
├──────────────────────────────────────────────────┼───────────────┼───────────────┤
│ https://reqres.in/api/users/api/users/999        │ DELETE        │ 403           │
└──────────────────────────────────────────────────┴───────────────┴───────────────┘

future: could have some options to display full headers and the response body --headers --response

Im currently trying out Hoppscotch, n it's pretty good but there's no built-in API documentation then i found this hoping it could help but it doesnt seem to give much help regarding API documentation. So the question being has this been completely abandon ?
(i'm sorry since this is not an actual issue but there's no disscussion tab so i have to post this here)