hugapi/hug

Put examples with the port

Open

#832 opened on Dec 15, 2019

View on GitHub
 (2 comments) (4 reactions) (0 assignees)Python (389 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (6,758 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I have this method:

@hug.get('/documents/list')
def llista():
    """Returns whole list of documents"""
    docs = [lib.Doc(doc).HeaderstoJSON for doc in glob.iglob('./*.md')]
    return {'documents': docs}

and http://localhost:8000 returns me:

"documentation": {
        "handlers": {
            "/documents/list": {
                "GET": {
                    "usage": "Returns whole list of documents",
                    "examples": [
                        "http://localhost/documents/list"
                    ],
                    "outputs": {
                        "format": "JSON (Javascript Serialized Object Notation)",
                        "content_type": "application/json; charset=utf-8"
                    }
                }
            },

but really the autogenerated documentation should say the port:

                        "http://localhost:8000/documents/list"
                    ],```

Contributor guide