hugapi/hug

Put examples with the port

Open

#832 ouverte le 15 déc. 2019

Voir sur GitHub
 (2 commentaires) (4 réactions) (0 assignés)Python (389 forks)batch import
enhancementhelp wanted

Métriques du dépôt

Stars
 (6 758 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Guide contributeur