Fork me on GitHub

Api genérica

July 17, 2017

Siempre ando necesitando una api para hacer pruebas, y como andaba con algo de tiempo se me ocurrió hacer una genérica, donde no tengas que definir nada previamente, donde todo sea dinámico, tanto los endpoints como los documentos. Me pareció además interesante como ejercicio, ¿cómo hacerla?, así fueron surgiendo Python, diccionarios, Flask, Docker...

Surgió así generic-api, una api schemeless, que además, al estar dockerizada, podés empezar a usar tirando un simple comando:

$ docker run -d --name generic-api -p 5000:5000 lvidarte/generic-api:latest

La api persiste los datos usando shelve. Si te interesa conservar los datos por fuera del container simplemente agregá esto a la línea de docker:

-v `pwd`/data:/app/data

Los métodos que soporta son GET, POST y DELETE.

Veamos un ejemplo guardando autores y libros. Primero creamos el endpoint /authors simplemente agregando un autor:

$ curl localhost:5000/authors -d '{"name": "Asimov"}'
{
  "_id": "1", 
  "name": "Asimov"
}

La api devuelve 201 y el documento insertado junto con su _id. Notar que no es necesario usar el header "Content-Type: application/json" ya que la api asume que le enviaremos jsons.

Ahora uso el id generado para referencialo y agregarle libros:

$ curl localhost:5000/authors/1/books -d '{"title": "Nemesis", "year": 1988}'
{
  "_id": "1", 
  "title": "Nemesis", 
  "year": 1988
}

$ curl localhost:5000/authors/1/books -d '{"title": "Foundation and Earth", "year": 1987}'
{
  "_id": "2", 
  "title": "Foundation and Earth", 
  "year": 1987
}

Si ahora pido /authors/1 veo el doc completo:

$ curl localhost:5000/authors/1
{
  "_id": "1", 
  "books": {
    "1": {
      "_id": "1", 
      "title": "Nemesis", 
      "year": 1988
    }, 
    "2": {
      "_id": "2", 
      "title": "Foundation and Earth", 
      "year": 1987
    }
  }, 
  "name": "Asimov"
}

También puedo acceder a cualquier nivel del doc simplemente escribiendo el path:

$ curl localhost:5000/authors/1/books/2/title
"Foundation and Earth"

$ curl localhost:5000/authors/1/books/2/year
1987

Y lo puedo modificar usando POST:

$ curl localhost:5000/authors/1/books/2/year -d '1986'
1986

$ curl localhost:5000/authors/1/books/2
{
  "_id": "2", 
  "title": "Foundation and Earth", 
  "year": 1986
}

Finalmente puedo borrar cualquier path:

$ curl -XDELETE localhost:5000/authors/1/books/2

$ curl localhost:5000/authors/1/books/2
{
  "error": "2 not in authors/1/books"
}

Python Trabajos