rest_framework.schemas.generators.EndpointEnumerator

class documentation

class EndpointEnumerator: (source)

View In Hierarchy

A class to determine the available API endpoints that a project exposes.

Method __init__ Undocumented
Method get_allowed_methods Return a list of the valid HTTP methods for this endpoint.
Method get_api_endpoints Return a list of all available API endpoints by inspecting the URL conf.
Method get_path_from_regex Given a URL conf regex, return a URI template string.
Method should_include_endpoint Return `True` if the given endpoint should be included.
Instance Variable patterns Undocumented
def __init__(self, patterns=None, urlconf=None): (source)

Undocumented

def get_allowed_methods(self, callback): (source)

Return a list of the valid HTTP methods for this endpoint.

def get_api_endpoints(self, patterns=None, prefix=''): (source)

Return a list of all available API endpoints by inspecting the URL conf.

def get_path_from_regex(self, path_regex): (source)

Given a URL conf regex, return a URI template string.

def should_include_endpoint(self, path, callback): (source)

Return `True` if the given endpoint should be included.

patterns = (source)

Undocumented