Documentando una API Rest de Django con la librería coreapi

Introdución

Partimos de que a API xa está desenvolta.

Podemos engadir documentación automática a nosa api coa librería coreapi executando o seguinte comando:

pip install coreapi

Incluiremos no noso fichiero fetlix/urls.py a ruta para acceder á documentación.

from rest_framework.documentation import include_docs_urls

urlpatterns = [
        ...
   path('docs/', include_docs_urls(title='My API title', public=False)),

Finalmente engadimos ó noso ficheiro fetlix/settings.py o compoñente que se encargará de xenerar a documentación. ‎ REST_FRAMEWORK = {'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema' }

Debería estar funcionando en:

http://localhost:8000/docs/. 

Desde esta documentación xa poden outros equipos comezar a probar a túa API.

Referencias

• Crea una API REST con Django desde cero (y en su paso final genera la documentación) - Openwebinars