jpadilla/notaso — pull request #59 by luisjorge129 (2014-05-27 08:04:33+00:00)
Title: Notaso REST API version 0.1

Bueno después de un par de dias de jugar con Django REST API termine haciendo este api para notaso. Intente de que los endpoints tuvieran la información mas importante, así que cualquier feedback es bienvenido.

Detalles del pull request
===================

1. **REST API**
- Cree el rest api con [Django REST Framework](http://www.django-rest-framework.org/) (como se sugirió en el issue #15).
- Para acceder al api solo tienen que entrar a 127.0.0.1:8000/api (esta pagina te va a mostrar los endpoints).
- Los endpoints creados son de las universidades, departamentos, profesores y el search.
- El api hasta ahora solo es readonly y no es requerido estar login para accederlo.
- En el proyecto de notaso solamente agregue un app aparte que se llama "restapi", toda la información del api sale de los modelos que ustedes tenian creados.

2. **Documentación**
- Para acceder a la documentación solo tienen que entrar a 127.0.0.1:8000/docs (esta pagina te va a mostrar los endpoints con información de como funcionan y te va a permitir probarlos).
- Cree la documentación con [Django REST Swagger](https://github.com/marcgibbons/django-rest-swagger).
- Esto lo agregue como algo opcional, si no les gusta se puede eliminar simplemente quitando todo lo relacionado a swagger en settings.py y eliminar docs del url.py principal.

**Mejoras en un futuro**
* Los endpoints que se utilizan para buscar una universidad/departamento/profesor en especifico por ahora funcionan con el id de estos, intente hacer que funcionaran con el slug pero falle miserablemente.

End Points
--------------
```
{
"universities": "http://127.0.0.1:8000/api/universities/",
"professors": "http://127.0.0.1:8000/api/professors/",
"search": "http://127.0.0.1:8000/api/search/",
"department": "http://127.0.0.1:8000/api/department/"
}
```

Me asegure de que todo funcionara perfectamente, pero cualquier cosita me dejan saber.