Merge 1bcf93a into ebd543d

dpgaspar · Apr 9, 2019 · 718ecad · 718ecad
2 parents ebd543d + 1bcf93a
commit 718ecad
Show file tree

Hide file tree

Showing 60 changed files with 34,552 additions and 342 deletions.
diff --git a/.gitignore b/.gitignore
@@ -13,4 +13,4 @@ env
 venv
 *.sublime*
 .vscode/
-
+.tox
diff --git a/README.rst b/README.rst
@@ -97,6 +97,13 @@ Includes:
       - Related Select2 fields.
       - Google charts with automatic group by or direct values and filters.
       - AddOn system, write your own and contribute.
+  - CRUD REST API
+      - Automatic CRUD RESTful APIs.
+      - Internationalization
+      - Integration with flask-jwt-extended extension to protect your endpoints.
+      - Metadata for dynamic rendering.
+      - Selectable columns and metadata keys.
+      - Automatic and configurable data validation.
   - Forms
       - Automatic, Add, Edit and Show from Database Models
       - Labels and descriptions for each field.

diff --git a/docs/api.rst b/docs/api.rst
@@ -20,6 +20,7 @@ flask_appbuilder.security.decorators
 
 .. automodule:: flask_appbuilder.security.decorators
 
+    .. autofunction:: protect
     .. autofunction:: has_access
     .. autofunction:: permission_name
 
@@ -30,6 +31,27 @@ flask_appbuilder.models.decorators
 
     .. autofunction:: renders
 
+flask_appbuilder.api
+==============================
+
+.. automodule:: flask_appbuilder.api
+
+    .. autofunction:: expose
+    .. autofunction:: rison
+    .. autofunction:: safe
+
+BaseApi
+-------
+
+.. autoclass:: BaseApi
+    :members:
+
+ModelRestApi
+------------
+
+.. autoclass:: ModelRestApi
+    :members:
+
 flask_appbuilder.baseviews
 ==============================
 

diff --git a/docs/config.rst b/docs/config.rst
@@ -194,6 +194,13 @@ Use config.py to configure the following parameters. By default it will use SQLL
 |                                   | the existing languages with the countries  |           |
 |                                   | name and flag                              |           |
 +-----------------------------------+--------------------------------------------+-----------+
+| FAB_API_SHOW_STACKTRACE           | Sends api stack trace on uncaught          |   No      |
+|                                   | exceptions. (Boolean)                      |           |
++-----------------------------------+--------------------------------------------+-----------+
+| FAB_API_MAX_PAGE_SIZE             | Sets a limit for FAB Model Api page size   |   No      |
++-----------------------------------+--------------------------------------------+-----------+
+| FAB_API_SWAGGER_UI                | Enables a Swagger UI view (Boolean)        |   No      |
++-----------------------------------+--------------------------------------------+-----------+
 
 
 Using config.py

diff --git a/docs/images/swagger001.png b/docs/images/swagger001.png
diff --git a/docs/images/swagger002.png b/docs/images/swagger002.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -35,6 +35,7 @@ Contents:
 
    views
    quickhowto
+   rest_api
    quickhowto_mongo
    quickcharts
    quickfiles

diff --git a/docs/quickhowto.rst b/docs/quickhowto.rst
@@ -284,6 +284,10 @@ in case of success or errors. See the following table for a description of each
 REST API
 --------
 
+note:
+    This sort of automatic REST API is going to be deprecated, and will
+    be completely removed in 2 minors.
+
 This API is still BETA and will be subject to change. In the future F.A.B. will probably use AngularJS
 to display the UI interface using AJAX.