API Reference

This section is a reference for classes and functions of Flask-RESTful-DBBase.

DBBase

DBBase([app, use_native_unicode, ...])

Resources

ModelResource()

ModelResource Class

CollectionModelResource()

CollectionModelResource Class

MetaResource()

This class enables documentation for a model resource.

DBBaseResource()

DBBaseResource Class

Generator

create_resource(name, resource_class[, ...])

This function creates a resource based on a source model class and a seed resource.

Doc Utils

MetaDoc(resource_class[, requirements, methods])

This class provides a scaffolding for holding documentation used when generating meta documents.

MethodDoc(method[, input, input_modifier, ...])

This class holds details about a method.