docs: updates and adds to examples folder.

examples/00_quickstart/README.md

@@ -23,7 +23,7 @@ Go to [http://127.0.0.1:5000/apidocs/](http://127.0.0.1:5000/apidocs/) in a brow
 
 ### Create a ToDo item
 ```
-curl -X POST --location "http://127.0.0.1:5000/todos" \
+curl -X POST --location "http://127.0.0.1:5000/todos/" \
     -H "Content-Type: application/json" \
     -d "{
             \"text\": \"take out garbage again\"
@@ -32,44 +32,44 @@ curl -X POST --location "http://127.0.0.1:5000/todos" \
 
 ### List all ToDo items (flat)
 ```
-curl -X GET --location "http://127.0.0.1:5000/todos" \
+curl -X GET --location "http://127.0.0.1:5000/todos/" \
     -d "Accept: application/json"
 ```
 
 ### List all ToDo items (paginated)
 ```
-curl -X GET --location "http://127.0.0.1:5000/todos?limit=2&offset=1" \
+curl -X GET --location "http://127.0.0.1:5000/todos/?limit=2&offset=1" \
     -d "Accept: application/json"
 ```
 
 ### Search ToDo items
 ```
-curl -X GET --location "http://127.0.0.1:5000/todos?search=garbage" \
+curl -X GET --location "http://127.0.0.1:5000/todos/?search=garbage" \
     -d "Accept: application/json"
 ```
 
 ### Filter ToDo items
 ```
-curl -X GET --location "http://127.0.0.1:5000/todos?filters=%7B%22text%22%3A+%22take+out+garbage+again%22%7D" \
+curl -X GET --location "http://127.0.0.1:5000/todos/?filters=%7B%22text%22%3A+%22take+out+garbage+again%22%7D" \
     -d "Accept: application/json"
 ```
 _querystring urldecodes to `filters={"text": "take out garbage again"}`_ 
 
 ### Sort ToDo items
 ```
-curl -X GET --location "http://127.0.0.1:5000/todos?sort=text" \
+curl -X GET --location "http://127.0.0.1:5000/todos/?sort=text" \
     -d "Accept: application/json"
 ``` 
 
 ### Fetch ToDo item
 ```
-curl -X GET --location "http://127.0.0.1:5000/todos/1" \
+curl -X GET --location "http://127.0.0.1:5000/todos/1/" \
     -d "Accept: application/json"
 ```
 
 ### Update ToDo item
 ```
-curl -X PUT --location "http://127.0.0.1:5000/todos/1" \
+curl -X PUT --location "http://127.0.0.1:5000/todos/1/" \
     -H "Content-Type: application/json" \
     -d "{
             \"text\": \"Updated todo item\"
@@ -78,7 +78,7 @@ curl -X PUT --location "http://127.0.0.1:5000/todos/1" \
 
 ### Patch ToDo item
 ```
-curl -X PATCH --location "http://127.0.0.1:5000/todos/1" \
+curl -X PATCH --location "http://127.0.0.1:5000/todos/1/" \
     -H "Content-Type: application/json" \
     -d "{
             \"text\": \"Updated todo item\"
@@ -87,7 +87,5 @@ curl -X PATCH --location "http://127.0.0.1:5000/todos/1" \
 
 ### Delete ToDo Item
 ```
-curl -X DELETE --location "http://127.0.0.1:5000/todos/1"
+curl -X DELETE --location "http://127.0.0.1:5000/todos/1/"
 ```
-
-

examples/01_authentication/README.md

@@ -22,6 +22,10 @@ curl to store/use cookies in order to test authenticated requests.
 
 `pipenv run python3 app.py`
 
+## Swagger UI
+
+Go to [http://127.0.0.1:5000/apidocs/](http://127.0.0.1:5000/apidocs/) in a browser.
+
 ## CURL Commands
 
 ### Login

examples/02_pydantic/README.md

@@ -14,11 +14,15 @@ generated by Flask-Muck.
 
 `pipenv run python3 app.py`
 
+## Swagger UI
+
+Go to [http://127.0.0.1:5000/apidocs/](http://127.0.0.1:5000/apidocs/) in a browser.
+
 ## CURL Commands
 
 ### Create a ToDo item
 ```
-curl -X POST --location "http://127.0.0.1:5000/api/v1/todos" \
+curl -X POST --location "http://127.0.0.1:5000/todos/" \
     -H "Content-Type: application/json" \
     -d "{
             \"text\": \"take out garbage again\"
@@ -27,44 +31,44 @@ curl -X POST --location "http://127.0.0.1:5000/api/v1/todos" \
 
 ### List all ToDo items (flat)
 ```
-curl -X GET --location "http://127.0.0.1:5000/api/v1/todos" \
+curl -X GET --location "http://127.0.0.1:5000/todos/" \
     -d "Accept: application/json"
 ```
 
 ### List all ToDo items (paginated)
 ```
-curl -X GET --location "http://127.0.0.1:5000/api/v1/todos?limit=2&offset=1" \
+curl -X GET --location "http://127.0.0.1:5000/todos/?limit=2&offset=1" \
     -d "Accept: application/json"
 ```
 
 ### Search ToDo items
 ```
-curl -X GET --location "http://127.0.0.1:5000/api/v1/todos?search=garbage" \
+curl -X GET --location "http://127.0.0.1:5000/todos/?search=garbage" \
     -d "Accept: application/json"
 ```
 
 ### Filter ToDo items
 ```
-curl -X GET --location "http://127.0.0.1:5000/api/v1/todos?filters=%7B%22text%22%3A+%22take+out+garbage+again%22%7D" \
+curl -X GET --location "http://127.0.0.1:5000/todos/?filters=%7B%22text%22%3A+%22take+out+garbage+again%22%7D" \
     -d "Accept: application/json"
 ```
 _querystring urldecodes to `filters={"text": "take out garbage again"}`_ 
 
 ### Sort ToDo items
 ```
-curl -X GET --location "http://127.0.0.1:5000/api/v1/todos?sort=text" \
+curl -X GET --location "http://127.0.0.1:5000/todos/?sort=text" \
     -d "Accept: application/json"
 ``` 
 
 ### Fetch ToDo item
 ```
-curl -X GET --location "http://127.0.0.1:5000/api/v1/todos/1" \
+curl -X GET --location "http://127.0.0.1:5000/todos/1/" \
     -d "Accept: application/json"
 ```
 
 ### Update ToDo item
 ```
-curl -X PUT --location "http://127.0.0.1:5000/api/v1/todos/1" \
+curl -X PUT --location "http://127.0.0.1:5000/todos/1/" \
     -H "Content-Type: application/json" \
     -d "{
             \"text\": \"Updated todo item\"
@@ -73,7 +77,7 @@ curl -X PUT --location "http://127.0.0.1:5000/api/v1/todos/1" \
 
 ### Patch ToDo item
 ```
-curl -X PATCH --location "http://127.0.0.1:5000/api/v1/todos/1" \
+curl -X PATCH --location "http://127.0.0.1:5000/todos/1/" \
     -H "Content-Type: application/json" \
     -d "{
             \"text\": \"Updated todo item\"
@@ -82,7 +86,5 @@ curl -X PATCH --location "http://127.0.0.1:5000/api/v1/todos/1" \
 
 ### Delete ToDo Item
 ```
-curl -X DELETE --location "http://127.0.0.1:5000/api/v1/todos/1"
+curl -X DELETE --location "http://127.0.0.1:5000/todos/1/"
 ```
-
-

examples/02_pydantic/app.py

@@ -3,9 +3,11 @@
 from pydantic import BaseModel
 from sqlalchemy.orm import DeclarativeBase
 
-from flask_muck import FlaskMuckApiView
+from flask_muck import FlaskMuckApiView, FlaskMuck
 
 app = Flask(__name__)
+muck = FlaskMuck()
+muck.init_app(app)
 
 
 class Base(DeclarativeBase):
@@ -31,9 +33,6 @@ class TodoPayloadSchema(BaseModel):
     text: str
 
 
-api_blueprint = Blueprint("v1_api", __name__, url_prefix="/api/v1/")
-
-
 class TodoApiView(FlaskMuckApiView):
     session = db.session
     api_name = "todos"
@@ -45,10 +44,8 @@ class TodoApiView(FlaskMuckApiView):
     searchable_columns = [TodoModel.text]
 
 
-TodoApiView.add_rules_to_blueprint(api_blueprint)
-app.register_blueprint(api_blueprint)
-
 if __name__ == "__main__":
     with app.app_context():
         db.create_all()
+        muck.register_muck_views([TodoApiView])
     app.run(debug=True)

examples/03_add_to_existing_api/Pipfile

@@ -0,0 +1,18 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+flask = "*"
+flask-sqlalchemy = "*"
+pipenv = "*"
+install = "*"
+flask-muck = {file = "../.."}
+webargs = "*"
+pydantic = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.11"