API documentation¶
API request handler¶
- class main.api.ConvertApi(**kwargs)¶
Bases:
GenericAPIViewMain class for Convertor API.
- Parameters:
serializer_class – serializer of
models.Conversionqueryset – set of serialized objects
- get(request)¶
Get request handler for showing conversion page view.
- Parameters:
request (
django.http.HttpRequest) – request details- Returns:
page render object
index.html- Return type:
django.http.HttpResponse
- static get_request_from(request) str¶
Static method to get request ip address
- Parameters:
request (
django.http.HttpRequest) – request details- Returns:
ip address
- Return type:
string
- post(request)¶
Post request handler for file conversion.
- Parameters:
request (
rest_framework.request.Request) – request details- Serializer:
convertSerializer formed with
models.Conversion- Returns:
server response object
- Return type:
rest_framework.response.Response
- static request_from_local(request) bool¶
Static method to check whether it is local request or not
- Parameters:
request (
django.http.HttpRequest) – request details- Returns:
boolean flag
- Return type:
boolean
- serializer_class¶
alias of
ConvertSerializer
- main.api.get_init_id()¶
Get id from file.
- Returns:
id
- Return type:
int