Automatically constructing URLs: url_for about flask-restful HOT 4 CLOSED

how do you anticipate using this? what would you expect the interface to look like?

from flask-restful.

According to HATEOAS, there need to be links. Consider the GitHub API itself for example: it isn't completely HATEOAS, but at least a little.

If there are links, then the API is in itself self-documenting. I suppose there could be something like a url_for function for Flask-RESTful too, which would take the first valid link it finds for a Resource:

class MyView(Resource):
    def get(self, my_id):
        pass

api.add_resource(MyView, '/mine/<int:my_id>', '/mine/another/<int:my_id>')
url_for(MyView) # which returns /mine/{my_id} or maybe according to a template...

Ok, you can see I haven't thought all too much about it.

It's hard to find good examples of this... maybe this one: Sun Cloud API Example.

Anyway, I anticipate using this like so:

{
    "message": "You are at the index. Check out the links!",
    "links": {
        "self": "/",
        "issues": "/you/issues",
        "repos": "/you/repos",
        "posts": "/you/posts"
    }
}

Or maybe like so:

{
    "collection": [
        { ..., "uri": "/you/repos/1" },
        { ..., "uri": "/you/repos/2" },
        { ..., "uri": "/you/repos/3" }
    ],
    "links": {
        "self": "/you/repos",
        "paginate": "/you/repos?offset={offset}&limit={limit}",
        "prev_page": null,
        "next_page": null
    }
}

Something like that.

from flask-restful.

We're trying to move toward providing Links natively soon.

from flask-restful.

Fixed by #110.

from flask-restful.