如何在flask restful api应用程序中配置basepath？

Question

I want to set a basepath for my flask application. I have mentioned one example below.

basepath = 'http://localhost:3000/api'

i have two api call one is GET and other one is POST .

from flask import Flask
from flask_restful import Api
app = Flask(__name__)
api = Api(app)

api.add_resource(CreateUser, "/v1/user/create/")
api.add_resource(CreateUser, "/v1/user/details")

class CreateUser(Resource):
    def post(self):
       # Code for creating a user
    def get(self):
       # Code for get the details of user.

So here, if i want to create the user then my url will be http://localhost:3000/api/v1/user/create/ so same for GET also . So how do i achieve this ?

Answer 1

Initialize your Api with the path prefix:

from flask import Flask
from flask_restful import Api
app = Flask(__name__)
api = Api(app, "/api")

...

You can't change the host and port this way, you'll have to run flask with parameters:

flask run --host=127.0.0.1 --port=3000

Or you could do

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app, "/api")


...

if __name__ == "__main__":
    app.run(host="127.0.0.1", port="3000")

Please keep in mind this is not intended for production environments, only for local testing. Please see https://flask.palletsprojects.com/en/1.1.x/tutorial/deploy/ for using in a production environment.

If you want to get those values from basepath , one option would be purl :

url = purl.URL('http://localhost:3000/api')
url.host()  # --> "localhost"
url.port()  # --> 3000
url.path()  # --> "/api"