This uses drf-yasg to generate documentation for all api endpoints based on a docstring placed after the class declaration of the view in the following format.
class Test(APIView):
"""
Description of what the endpoint does
* All required and optional arguments, query parameters and filters in the form `param` -- Description of param
* Can be a list or part of a list
For Example:
**Required Query Parameters:**
* ONE of the following:
* `registered_ip` -- IP address registered to an address
* `ip_address` -- Either a registered IP or a leased IP
"""
pass
WIP on APIDocs-Swagger branch.
Swagger is a specification for API Documentation.
This uses drf-yasg to generate documentation for all api endpoints based on a docstring placed after the class declaration of the view in the following format.