hugapi/hug

Put examples with the port

Open

#832 aperta il 15 dic 2019

Vedi su GitHub
 (2 commenti) (4 reazioni) (0 assegnatari)Python (389 fork)batch import
enhancementhelp wanted

Metriche repository

Star
 (6758 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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"
                    ],```

Guida contributor