OpenQuizz
Une application de gestion des contenus pédagogiques
|
Data Structures | |
class | Swagger |
Functions | |
def | ref (model) |
def | extract_path (path) |
def | extract_path_params (path) |
def | parse_docstring (obj) |
def | is_hidden (resource, route_doc=None) |
Variables | |
dictionary | PATH_TYPES |
dictionary | PY_TYPES |
RE_URL = re.compile(r'<(?:[^:<>]+:)?([^<>]+)>') | |
string | DEFAULT_RESPONSE_DESCRIPTION = 'Success' |
dictionary | DEFAULT_RESPONSE = {'description': DEFAULT_RESPONSE_DESCRIPTION} |
RE_RAISES = re.compile(r'^:raises\s+(?P<name>[\w\d_]+)\s*:\s*(?P<description>.*)$', re.MULTILINE) | |
def flask_restplus.swagger.extract_path | ( | path | ) |
Transform a Flask/Werkzeug URL pattern in a Swagger one.
def flask_restplus.swagger.extract_path_params | ( | path | ) |
Extract Flask-style parameters from an URL pattern as Swagger ones.
def flask_restplus.swagger.is_hidden | ( | resource, | |
route_doc = None |
|||
) |
Determine whether a Resource has been hidden from Swagger documentation i.e. by using Api.doc(False) decorator
def flask_restplus.swagger.parse_docstring | ( | obj | ) |
def flask_restplus.swagger.ref | ( | model | ) |
Return a reference to model in definitions
dictionary DEFAULT_RESPONSE = {'description': DEFAULT_RESPONSE_DESCRIPTION} |
string DEFAULT_RESPONSE_DESCRIPTION = 'Success' |
dictionary PATH_TYPES |
dictionary PY_TYPES |
RE_RAISES = re.compile(r'^:raises\s+(?P<name>[\w\d_]+)\s*:\s*(?P<description>.*)$', re.MULTILINE) |
RE_URL = re.compile(r'<(?:[^:<>]+:)?([^<>]+)>') |