¿Cómo escribir una API Flask simple para hello world?

Requisitos previos: Introducción a la API REST 

REST significa Transferencia de estado representacional y es un estilo arquitectónico utilizado en el desarrollo web moderno. Define un conjunto de reglas/restricciones para que una aplicación web envíe y reciba datos. En este artículo, vamos a aprender cómo crear una API REST simple que devuelva «Hello World», con la ayuda de un matraz.

En este artículo, vamos a escribir una API de matraz simple para hello world usando dos métodos:

• Usando el objeto Flask jsonify.
• Uso de la biblioteca Flask_restful con Flask.

Instalación

1. Instale la biblioteca python Flask con el siguiente comando.

pip install Flask

2. Instale la biblioteca de Flass-Restful con el siguiente comando.

pip install Flask-RESTful

Método 1: usar el objeto Flask ‘jsonify’

• Cree un nuevo archivo python llamado ‘main.py’.
• Importe Flask, jsonify y solicite desde el marco de Flask.
• Registre la aplicación web en una variable de aplicación con la siguiente sintaxis.

app =   Flask(__name__)

• Cree una nueva función llamada ‘helloworld’. Esta función devolverá el texto ‘Hello World’ en formato JSON.
• Dirija la función ‘helloworld’ a su URL deseada usando la siguiente sintaxis.

@app.route('/path_of_the_response', methods=['GET'])
def helloworld():
    pass

• Dentro de la función ‘helloworld’, si el método de solicitud es ‘GET’, cree un diccionario de Python con el mensaje ‘Hello World’.
• Jsonifique el diccionario de python y devuélvalo.
• Compile la aplicación del matraz con el siguiente comando.

if __name__ == '__main__':
    app.run(debug=True)

• Ejecute el archivo ‘main.py’ en la terminal o el IDE y escriba la siguiente URL en el navegador.

http://127.0.0.1:5000/hello

Código:

from flask import Flask, jsonify, request
  
app = Flask(__name__)
  
  
@app.route('/hello', methods=['GET'])
def helloworld():
    if(request.method == 'GET'):
        data = {"data": "Hello World"}
        return jsonify(data)
  
  
if __name__ == '__main__':
    app.run(debug=True)

Producción :

Método 2: Uso de la biblioteca matraz_restful 

• Cree un nuevo archivo python llamado ‘main.py’.
• Importe Flask desde el marco del matraz.
• Importe API y recursos de la biblioteca ‘flask_restful’.
• Registre la aplicación web en una variable de aplicación con la siguiente sintaxis.

app =   Flask(__name__)

• Registre la variable de la aplicación como un objeto API usando el método Api de la biblioteca ‘flask_restful’.

api =   Api(app)

• Cree una clase de recurso llamada ‘HelloWorld’.
• Dentro de la clase de recursos, cree un método ‘get’.
• Devuelve un diccionario con el mensaje ‘Hello World’ del método ‘get’.
• Agregue la clase de recurso a la API mediante el método add_resource.
• Compile la aplicación del matraz con el siguiente comando.

if __name__ == '__main__':
    app.run(debug=True)

• Ejecute el archivo ‘main.py’ en la terminal o el IDE y escriba la siguiente URL en el navegador.

http://127.0.0.1:5000/hello

Código:

from flask import Flask
from flask_restful import Api, Resource
  
app =   Flask(__name__)
  
api =   Api(app)
  
class HelloWorld(Resource):
    def get(self):
        data={"data":"Hello World"}
        return data
  
api.add_resource(HelloWorld,'/hello')
  
  
if __name__=='__main__':
    app.run(debug=True)

Producción :