Django API Client

Requirements

How to install

$ pip install django-api-client

$ git clone git@github.com:rhenter/django_api_client.git$cd django_api_client$ python setup.py install

Settings

INSTALLED_APPS= (    ...'django_api_client',    ...)

Example

DJANGO_API_CLIENT= {'API': [    {'NAME':'production','BASE_URL':'https://example.com','ENDPOINTS': ['/v1/order/orders','/v1/user/users',            ...        ],'AUTHENTICATION_ACCESS_TOKEN':'TOKEN'    },    {'NAME':'localhost','BASE_URL':'http://localhost:8001','ENDPOINTS': ['/v1/order/orders','/v1/user/users',            ...        ],'AUTHENTICATION_ACCESS_TOKEN':'TOKEN'    }  ]}

Note

The details of the configuration will be better explained in the documentation

fromdjango_api_client.clientimportapi_client_factoryapi_client=api_client_factory('production')

Note

• The name of this variable will be the name of the client that you can use throughout your project
• It is recommended that the production use a set of configurations without configurations.py to change the simple way or the name of the API without the need to create several.
• In our case, we have the option of "production" and "localhost", the factory generates the customer according to the name used and the parameters identified in it

fromdjango_api_client.mixinsimportClientAPIListMixinfrompasta_do_projeto.clientsimportapi_clientclassOrderListView(ClientAPIListMixin):template_name="template_name.html"# Path where is your templatepage_title='Orders'# Generates a context variable to use in your templatepage_base_url=reverse_lazy('order:list')# Information used in pagination, and the searchpaginate_by=50# Number of items to generate the paginationclient_method=api_client.order.orders.list

Note

The client will generate a user-friendly structure for each endpoint. Example with the endpoint/order/orders/:

{%content%}...<divclass="card card-navy card-outline">  <divclass="card-header">    <h3class="card-title">{%trans"Order List"%} : <smallclass="text-muted">{{ paginator.count }}</small>    </h3>{%include"includes/form_paginate_by.html"withpaginate_by=paginate_byrange_pagination=range_pagination%}{%include"includes/form_search.html"withsearch=search%}  </div>  <divclass="card-body table-responsive p-0">    <tableclass="table table-bordered table-hover table-striped"id="list-content">      <thead>      <tr>        <th>{%trans'Code'%}</th>        <th>{%trans'Customer'%}</th>        <th>{%trans'Product'%}</th>      </tr>      </thead>      <tbodyclass="text-gray">{%fororderinobject_list%}        <tr>          <td><ahref="{% url 'order:detail' pk=order.id %}" </a>          </td>          <td>{{ order.id }}</td>          <td>{{ order.customer.name|title }}</td>          <td>{{ order.product.name|title }}</td>        </tr>{%endfor%}{%endif%}      </tbody>    </table>  </div>  <divclass="card-footer">{%ifobject_list|length != 0ornotobject_list%}{%include"includes/list_paginator.html"withpage_obj=page_objpaginator=paginator%}{%endif%}  </div></div>

Note

• Example using Bootstrap Styles(CSS)
• includes/form_search.html: Form with search input. Thisinclude support placeholder too.
• includes/form_paginate_by.html: Select form to choose how many elements the page will be paginate. Ex: by (20, 40, 60, etc ...)
• includes/list_paginator.html: Block with pagination elements with the number of pages buttons, previous and next

Hint

What does that mean?

That the API Client will always generate the structure according to the names of their endpoints

Documentation

Contributing