Creación del Endpoint de Cryptongo

Clase 35 de 48 • Curso de MongoDB y Redis 2017

Resumen

Vamos a definir los endpoints para poder llamar las funciones definidas en el API.

CarlosHP

student•

Para los usuarios de Windows para crear la variable de entorno deben ejecutar en la consola:

$ set FLASK_APP=main.py

Y Luego el comando:

$ flask run

Onasis Gonzalo Soto Castro

student•

Gracias, funciona 😄

Usuario anónimo

user•

¡Gracias!

Hector Vasquez

student•

Dejo mi código funcionando, con comentarios explicativos:

import pymongo #Librería para comunicarse con la bd mongodb
from flask import Flask, jsonify, request #Flask es para levantar un servidor web. jsonify para poder retornar un json como respuesta al cliente. request permite capturar peticiones rest

#Función para crear conexión a la bd
def get_db_connection(uri):
	client = pymongo.MongoClient(uri) #Crear una conexión a la bd
	return client.cryptongo #Devolver bd cryptongo

app = Flask(__name__) #Crear un servidor web a partir del nombre del archivo ejecutado
db_connection = get_db_connection('mongodb://localhost:27017/') #Conexión a la bd

#Función para obtener lista de documentos a devolver
def get_documents():
	params = {} #Defino un diccionario de datos
	name = request.args.get('name', '') #Obtengo el campo "name", recibido por get. Si no existe, devuelve vacío
	limit = int(request.args.get('limit', 0)) #Obtengo el campo "limit", recibido por get. Si no existe, devuelve 0. Fuerzo conversión a entero

	if name: #Si existe "name"
		params.update({'name', name}) #Lo agrego al diccionario de datos

	cursor = db_connection.tickers.find( #Busco tickers
		params, #, según lo que recibí por get
		{'_id': 0, 'ticker_hash': 0} #Campos omitidos
	).limit(limit)

	return list(cursor) #convertir resultados de bd en una lista y devolverlo como respuesta a la petición

#Función para obtener el top20 de documentos
def get_top20():
	params = {} #Defino un diccionario de datos
	name = request.args.get('name', '') #Obtengo el campo "name", recibido por get. Si no existe, devuelve vacío
	limit = int(request.args.get('limit', 0)) #Obtengo el campo "limit", recibido por get. Si no existe, devuelve 0. Fuerzo conversión a entero

	if name: #Si existe "name"
		params.update({'name', name}) #Lo agrego al diccionario de datos

	params.update({'rank': {'$lte': 20}}) #Agrego condición para el find, inicando que el campo "rank" debe ser menor o igual a 20

	cursor = db_connection.tickers.find( #Busco tickers
		params, #, según lo que recibí por get
		{'_id': 0, 'ticker_hash': 0} #Campos omitidos
	).limit(limit)

	return list(cursor) #convertir resultados de bd en una lista y devolverlo como respuesta a la petición

#Función para eliminar un documento
def remove_currency():
	params = {} #Defino un diccionario de datos
	name = request.args.get('name', '') #Obtengo el campo "name", recibido por get. Si no existe, devuelve vacío

	if name: #Si existe "name"
		params.update({'name', name}) #Lo agrego al diccionario de datos
	else:
		return False

	return db_connection.tickers.delete_many( #Borro todos los documentos que coincidan con el dato recibido por get
		params
	).delete_count() #Retorna la cantida de documentos borrados

@app.route("/") #Defino la ruta raíz para recibir peticiones
def index(): #Cuando alguien pida esta ruta, se ejecutará esta función
	return jsonify( #Retornará una respuesta en formato json
		{
			'name': 'Cryptongo API'
		}
	)

@app.route("/top20", methods=['GET']) #Defino ruta GET para top20
def top20(): #Se ejecutará esta función cuando alguien entre a esa ruta
	return jsonify(get_top20()) #Devuelvo un json con la lista de top20```

Ariel Coyant

student•

Gracias por el esfuerzo!

Pablo Daniel Jacobo Sanchez

student•

Gracias Men

Jhon Alexander Leon Ortecho

student•

En mi caso me salia este error en windows:

Error: Could not locate Flask application. You did not provide the FLASK_APP environment variable.

Lo solucione agregando al final del codigo de api/main.py lo siguiente:

if __name__ == "__main__":
    app.run()

y corri en la consola python

Freddy Córdova Arana

student•

Gracias por compartir tu solución, me salvaste 😄

Jesus Sandrea

student•

Me sale este error y no entiendo nada

PS C:\users\fireball\desktop\cryptongo\api> set FLASK_APP=main.py
PS C:\users\fireball\desktop\cryptongo\api> flask run
flask : The term 'flask' is not recognized as the name of a
cmdlet, function, script file, or operable program. Check the
spelling of the name, or if a path was included, verify that the
path is correct and try again.
At line:1 char:1
+ flask run
+ ~~~~~
    + CategoryInfo          : ObjectNotFound: (flask:String) [],
   CommandNotFoundException
    + FullyQualifiedErrorId : CommandNotFoundException```

Diego Forero

Team Platzi•

Instalaste flask usando pip?

Constantino Celis Peñaranda

student•

Al ejecutar el comando FLASK_APP= flask run me genera el error FLASK_APP: Orden no encontrada, ¿A qué se debe esto?

Diego Forero

Team Platzi•

Puedes compartir tu archivo para ayudarte a encontrar el error.

Cesar David Ramírez Dimaté

student•

cd api
export FLASK_APP=main.py
flask run

Cesar David Ramírez Dimaté

student•

Dejo un repositorio en GitHub que indica el proceso de instalación, documentación del código y optimización del mismo.

William Meza

student•

Me da el siguiente error al hacer flask run

Traceback (most recent call last):
  File "/Library/Frameworks/Python.framework/Versions/3.6/bin/flask", line 11, in <module>
    sys.exit(main())
  File "/Library/Frameworks/Python.framework/Versions/3.6/lib/python3.6/site-packages/flask/cli.py", line 513, in main
    cli.main(args=args, prog_name=name)
  File "/Library/Frameworks/Python.framework/Versions/3.6/lib/python3.6/site-packages/flask/cli.py", line 380, in main
    return AppGroup.main(self, *args, **kwargs)
  File "/Library/Frameworks/Python.framework/Versions/3.6/lib/python3.6/site-packages/click/core.py",line 676, in main
    _verify_python3_env()
  File "/Library/Frameworks/Python.framework/Versions/3.6/lib/python3.6/site-packages/click/_unicodefun.py", line 118, in _verify_python3_env
    'for mitigation steps.' + extra)
RuntimeError: Click will abort further execution because Python 3 was configured to use ASCII as encoding for the environment.  Consult http://click.pocoo.org/python3/for mitigation steps.

This system lists a couple of UTF-8 supporting locales that
you can pick from.  The following suitable locales where
discovered: af_ZA.UTF-8, am_ET.UTF-8, be_BY.UTF-8, bg_BG.UTF-8, ca_ES.UTF-8, cs_CZ.UTF-8, da_DK.UTF-8, de_AT.UTF-8, de_CH.UTF-8, de_DE.UTF-8, el_GR.UTF-8, en_AU.UTF-8, en_CA.UTF-8, en_GB.UTF-8, en_IE.UTF-8, en_NZ.UTF-8, en_US.UTF-8, es_ES.UTF-8, et_EE.UTF-8, eu_ES.UTF-8, fi_FI.UTF-8, fr_BE.UTF-8, fr_CA.UTF-8, fr_CH.UTF-8, fr_FR.UTF-8, he_IL.UTF-8, hr_HR.UTF-8, hu_HU.UTF-8, hy_AM.UTF-8, is_IS.UTF-8, it_CH.UTF-8, it_IT.UTF-8, ja_JP.UTF-8, kk_KZ.UTF-8, ko_KR.UTF-8, lt_LT.UTF-8, nl_BE.UTF-8, nl_NL.UTF-8, no_NO.UTF-8, pl_PL.UTF-8, pt_BR.UTF-8, pt_PT.UTF-8, ro_RO.UTF-8, ru_RU.UTF-8, sk_SK.UTF-8, sl_SI.UTF-8, sr_YU.UTF-8, sv_SE.UTF-8, tr_TR.UTF-8, uk_UA.UTF-8, zh_CN.UTF-8, zh_HK.UTF-8, zh_TW.UTF-8

Click discovered that you exported a UTF-8 locale
but the locale system could not pick up from it because
it does not exist.  The exported locale is "es_419.UTF-8" but it
is not supported
UserBackend:cryptongo workmac$ FLASK_APP=api/main.py flask run
Traceback (most recent call last):
  File "/Library/Frameworks/Python.framework/Versions/3.6/bin/flask", line 11, in <module>
    sys.exit(main())
  File "/Library/Frameworks/Python.framework/Versions/3.6/lib/python3.6/site-packages/flask/cli.py", line 513, in main
    cli.main(args=args, prog_name=name)
  File "/Library/Frameworks/Python.framework/Versions/3.6/lib/python3.6/site-packages/flask/cli.py", line 380, in main
    return AppGroup.main(self, *args, **kwargs)
  File "/Library/Frameworks/Python.framework/Versions/3.6/lib/python3.6/site-packages/click/core.py",line 676, in main
    _verify_python3_env()
  File "/Library/Frameworks/Python.framework/Versions/3.6/lib/python3.6/site-packages/click/_unicodefun.py", line 118, in _verify_python3_env
    'for mitigation steps.' + extra)
RuntimeError: Click will abort further execution because Python 3 was configured to use ASCII as encoding for the environment.  Consult http://click.pocoo.org/python3/for mitigation steps.

This system lists a couple of UTF-8 supporting locales that
you can pick from.  The following suitable locales where
discovered: af_ZA.UTF-8, am_ET.UTF-8, be_BY.UTF-8, bg_BG.UTF-8, ca_ES.UTF-8, cs_CZ.UTF-8, da_DK.UTF-8, de_AT.UTF-8, de_CH.UTF-8, de_DE.UTF-8, el_GR.UTF-8, en_AU.UTF-8, en_CA.UTF-8, en_GB.UTF-8, en_IE.UTF-8, en_NZ.UTF-8, en_US.UTF-8, es_ES.UTF-8, et_EE.UTF-8, eu_ES.UTF-8, fi_FI.UTF-8, fr_BE.UTF-8, fr_CA.UTF-8, fr_CH.UTF-8, fr_FR.UTF-8, he_IL.UTF-8, hr_HR.UTF-8, hu_HU.UTF-8, hy_AM.UTF-8, is_IS.UTF-8, it_CH.UTF-8, it_IT.UTF-8, ja_JP.UTF-8, kk_KZ.UTF-8, ko_KR.UTF-8, lt_LT.UTF-8, nl_BE.UTF-8, nl_NL.UTF-8, no_NO.UTF-8, pl_PL.UTF-8, pt_BR.UTF-8, pt_PT.UTF-8, ro_RO.UTF-8, ru_RU.UTF-8, sk_SK.UTF-8, sl_SI.UTF-8, sr_YU.UTF-8, sv_SE.UTF-8, tr_TR.UTF-8, uk_UA.UTF-8, zh_CN.UTF-8, zh_HK.UTF-8, zh_TW.UTF-8

Click discovered that you exported a UTF-8 locale
but the locale system could not pick up from it because
it does not exist.  The exported locale is "es_419.UTF-8" but it
is not supported

William Meza

student•

lo solucione usando estos 2 comandos

export LC_ALL=es_ES.UTF-8
export LANG=es_ES.UTF-8

Cesar David Ramírez Dimaté

student•

Es en MacOS?

Cris from PappCorn

student•

me sale este error al correr el flask run

Error: The file/path provided (main) does not appear to exist.  Please verify the path is correct.  If app is not on PYTHONPATH, ensure the extension is .py```

Diego Forero

Team Platzi•

En que sistema operativo estas corriendo la aplicación?

El error indica que no encuentra la ruta, revisa que no tengas un error de digitación, si puedes comparte el código de tu archivo de python, te podemos ayudar mejor.

Cris from PappCorn

student•

estoy trabajando sobre macOs
en la raíz de mi proyecto tengo la carpeta api y esta contiene el archivo .
Este es el código de

import pymongo
from flask import Flask, jsonify, request


def get_db_connection(uri):
    '''Get conecction to server'''
    cliente = pymongo.MongoClient(uri)
    return cliente.cursomongo


app = Flask(__name__)
db_connection = get_db_connection('mongodb://127.0.0.1:27017/')


def get_documents():
    params = {}
    name = request.args.get('name', '')
    limit = int(request.args.get('limit', 0))
    if name:
        params.update({'name': name})
    cursor = db_connection.tickers.find(params).limit(limit)
    return list(cursor)


def get_top20():
    params = {}
    name = request.args.get('name', '')
    limit = int(request.args.get('limit', 0))
    if name:
        params.update({'name': name})
    params.update({'rank': {'$lte': 20}})
    cursor = db_connection.tickers.find(params).limit(limit)
    return list(cursor)


def remove_currency():
    params = {}
    name = request.args.get('name', '')
    if name:
        params.update({'name': name})
    else:
        return False
    return db_connection.tickers.delete_many(
        params
    ).deleted_count


@app.route("/")
def index():
    return jsonify(
        {
            'name': 'Cryptongo api'
        }
    )

en la consola corrí el siguiente comando

FLASK_APP=api/main.py flask run

Kevin Costa

student•

No entiendo nada. Falla.

BP-de-Kevin:API kevinch3$ flask run
 * Serving Flask app "main.py"
 * Environment: production
   WARNING: Do not use the development server in a production environment.
   Use a production WSGI server instead.
 * Debug mode: off
Traceback (most recent call last):
  File "/usr/local/bin/flask", line 11, in <module>
    sys.exit(main())
  File "/usr/local/lib/python3.7/site-packages/flask/cli.py", line 894, in main
    cli.main(args=args, prog_name=name)
  File "/usr/local/lib/python3.7/site-packages/flask/cli.py", line 557, in main
    return super(FlaskGroup, self).main(*args, **kwargs)
  File "/usr/local/lib/python3.7/site-packages/click/core.py", line 717, in main
    rv = self.invoke(ctx)
  File "/usr/local/lib/python3.7/site-packages/click/core.py", line 1137, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/local/lib/python3.7/site-packages/click/core.py", line 956, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/usr/local/lib/python3.7/site-packages/click/core.py", line 555, in invoke
    return callback(*args, **kwargs)
  File "/usr/local/lib/python3.7/site-packages/click/decorators.py", line 64, in new_func
    return ctx.invoke(f, obj, *args, **kwargs)
  File "/usr/local/lib/python3.7/site-packages/click/core.py", line 555, in invoke
    return callback(*args, **kwargs)
  File "/usr/local/lib/python3.7/site-packages/flask/cli.py", line 767, in run_command
    app = DispatchingApp(info.load_app, use_eager_loading=eager_loading)
  File "/usr/local/lib/python3.7/site-packages/flask/cli.py", line 293, in __init__
    self._load_unlocked()
  File "/usr/local/lib/python3.7/site-packages/flask/cli.py", line 317, in _load_unlocked
    self._app = rv = self.loader()
  File "/usr/local/lib/python3.7/site-packages/flask/cli.py", line 372, in load_app
    app = locate_app(self, import_name, name)
  File "/usr/local/lib/python3.7/site-packages/flask/cli.py", line 235, in locate_app
    __import__(module_name)
  File "/Volumes/Datos/KEVIN/Cursos/mongodb/API/main.py", line 28
    params.update({'rank': {'$lte': 20}})
                                        ^
IndentationError: unindent does not match any outer indentation level
MBP-de-Kevin:API kevinch3$

Ricardo Celis

teacher•

¿Cómo dejar expuesto un Endpoint?
eso lo puedes hacer según el backend que estés utilizando, puedes ir al curso de php con laravel para aprender a exponer un endpoint =)
platzi.com/laravel
pero igual se puede hacer con python y django, Node, Ruby on rails =)

Daniel Sepulveda

student•

por alguna razón me salen 40 monedas

import pymongo
from flask import Flask, jsonify, request


def get_db_connection(uri):
    client = pymongo.MongoClient(uri)
    return client.cryptongo


app = Flask(__name__)
db_connection = get_db_connection('mongodb://localhost:27017/')


def get_documents():
    params = {}
    name = request.args.get('name', '')
    limit = int(request.args.get('limit', 0))
    if name:
        params.update({'name': name})
    cursor = db_connection.tickers.find(
        params, {'_id': 0, 'ticker_hash': 0}
    ).limit(limit)
    return list(cursor)


def get_top20():
    params = {}
    name = request.args.get('name', '')
    limit = int(request.args.get('limit', 0))
    if name:
        params.update({'name': name})
    params.update({'rank': {'$lte': 20}})
    cursor = db_connection.tickers.find(
        params, {'_id': 0, 'ticker_hash': 0}
    ).limit(limit)
    return list(cursor)


def remove_currency():
    params = {}
    name = request.args.get('name', '')
    if name:
        params.update({'name': name})
    else:
        return False
    return db_connection.tickers.delete_many(
        params
    ).deleted_count


@app.route("/")
def index():
    return jsonify(
        {
            'name': "Cryptongo API"
        }
    )


@app.route("/top20", methods=['GET'])
def top20():
    return jsonify(get_top20())

Cesar David Ramírez Dimaté

student•

Es porque el endpoint no trae las primeras 20 monedas. Si revisas la consulta es que busca todas las criptomonedas donde el rank sea menor o igual a 20, entonces puede mas de 20 documentos cumplan esa condición.

Creación del Endpoint de Cryptongo

¡Espera pronto la actualización de este curso!

¡Nos estamos renovando!

Introducción al Curso de MongoDB y Redis

Bienvenidos al Curso de MongoDB y Redis

¿Qué es NoSQL?

Implementaciónes de bases de datos no relacionales - NoSQL

Ventajas y desventajas de NoSQL

Diferencias con SQL

Introducción a Cryptongo

MongoDB

Primeros pasos con MongoDB

Instalación de MongoDB en Linux

Instalación de MongoDB en Windows

Instalación de MongoDB en Mac

Modelado de datos en MongoDB relaciones uno a uno y uno a muchos

Modelado de datos tipo árbol

Creando el modelo de datos de Cryptongo

Librerías de MongoDB - PyMongo 1

Librerías de MongoDB - PyMongo 1 instalación de pymongo de acuerdo con el sistema operativo.

Introducción a la Shell de Mongo

Ejecución de código JS en la shell de MongoDB

Operaciones CRUD en MongoDB

Insertar un documento con la consola de Mongo

Insertar multiples documentos con la consola de Mongo

Funciones find y findOne

Operaciones avanzadas con find y findOne en la consola

Modificación de documentos en la consola de MongoDB

Funciones de Mongo updateOne - updateMany

Eliminar documentos en la consola de MongoDB

Indices en MongoDB

Desarrollo del proyecto Cryptongo

Estructura del proyecto Cryptongo

Librerías que usaremos en Cryptongo y cómo instalarlas

Cómo funciona el agente que consulta Coinmarketcap

Creando el agente que consulta en Coinmarketcap

Calcular el hash a partir de la información del ticker en Cryptongo

Guardar la información obtenida por el agente

Crear API que consulta la base de datos get_documents()

Funciones get_top20() y remove_currency()

Creación del Endpoint de Cryptongo

Endpoint /tickers para ver todos los documentos en cryptongo

Publicación de Cryptongo con Docker

Redis

Primeros pasos con Redis

Instalación de Redis en Ubuntu Linux

Instalación de Redis en Windows

Instalación de Redis en Mac

Consola Interactiva de Redis - Redis CLI

Insertar y leer datos en Redis

Eliminar datos en Redis

Full page cache con Redis

SetEx, cómo guardar un registro que tenga una fecha de vencimiento.

FLUSHDB, FLUSHALL, cómo eliminar una BD o todas las BD.

Cierre del curso