APIFlask 2.3.2__tar.gz → 3.0.0__tar.gz

{apiflask-2.3.2 → apiflask-3.0.0}/CHANGES.md

@@ -1,3 +1,40 @@
+## Version 3.0.0
+
+Released: 2025/11/15<br>Codename: Yixian | 逸仙
+
+- Add support for Python 3.14.
+- Drop support for Python 3.8 and PyPy 3.10.
+- Decouple from marshmallow and add an adapter system to support different serialization/deserialization libraries ([pr #690](pr_690)).
+- Add support for Pydantic models as data schemas ([issue #519][issue_519]).
+- Fix subclassed MethodView resources cannot be added as URL rules ([issue #618][issue_618]).
+- Add support for API key auth with `APIKeyHeaderAuth`, `APIKeyCookieAuth`, and `APIKeyQueryAuth`. Add support for runtime selection of authentication methods with `MultiAuth`. Deprecate the API key auth with HTTPTokenAuth ([issue #604][issue_604]).
+- Remove implicit security scheme naming rules ([pr #665](pr_665)).
+- Remove implicit schema naming change (i.e. 'Schema' suffix stripping) ([pr #693](pr_693)).
+- Deprecate the `EmptySchema` class. Use empty dict `{}` instead ([pr #694][pr_694]).
+- Remove the deprecated `__version__` attribute. Use feature detection or `importlib.metadata.version("apiflask")` instead.
+- Fix the support for marshmallow DelimitedList field in OpenAPI spec generation ([issue #416][issue_416]).
+
+[issue_519]: https://github.com/apiflask/apiflask/issues/519
+[pr_690]: https://github.com/apiflask/apiflask/pull/690
+[issue_618]: https://github.com/apiflask/apiflask/issues/618
+[issue_604]: https://github.com/apiflask/apiflask/issues/604
+[pr_655]: https://github.com/apiflask/apiflask/pull/655
+[pr_693]: https://github.com/apiflask/apiflask/pull/693
+[pr_694]: https://github.com/apiflask/apiflask/pull/694
+[issue_416]: https://github.com/apiflask/apiflask/issues/416
+
+
+## Version 2.4.0
+
+Released: 2025/3/25
+
+- Add `docs_oauth2_redirect_path_external` parameter to support absolute OAuth2 redirect url ([issue #602][issue_602]).
+- Change the default docs CDN to jsDelivr by default instead of unpkg ([pr #650](pr_650)).
+
+[issue_602]: https://github.com/apiflask/apiflask/issues/602
+[pr_650]: https://github.com/apiflask/apiflask/pull/650
+
+
 ## Version 2.3.2
 
 Released: 2024/12/15
@@ -125,7 +162,7 @@ Released: 2023/8/15
 
 ## Version 2.0.0
 
-Released: 2023/7/26<br>Codename: Gongqing
+Released: 2023/7/26<br>Codename: Gongqing ｜ 共青
 
 Please see the [migration guide](/migration_guide/#migrate-to-apiflask-2x) for APIFlask 1.x -> 2.0.0.
 
@@ -321,7 +358,7 @@ Released: 2022/5/17
 
 ## Version 1.0.0
 
-Released: 2022/5/4<br>Codename: Wujiaochang
+Released: 2022/5/4<br>Codename: Wujiaochang ｜ 五角场
 
 - Remove the deprecated standalone decorators: `input`, `output`, `doc`, and `auth_required`.
   Use app/blueprint decorators instead (e.g. `input()` -> `app.input()`/`bp.input()`).

{apiflask-2.3.2 → apiflask-3.0.0}/PKG-INFO

@@ -1,7 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: APIFlask
-Version: 2.3.2
-Summary: A lightweight web API framework based on Flask and marshmallow-code projects.
+Version: 3.0.0
+Summary: A lightweight web API framework based on Flask.
 Author-email: Grey Li <withlihui@gmail.com>
 License: MIT
 Project-URL: Documentation, https://apiflask.com/docs
@@ -9,17 +9,17 @@ Project-URL: Changes, https://apiflask.com/changelog
 Project-URL: Source Code, https://github.com/apiflask/apiflask
 Project-URL: Issue Tracker, https://github.com/apiflask/apiflask/issues
 Project-URL: Donate, https://opencollective.com/apiflask
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Flask
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
@@ -29,18 +29,20 @@ Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: NOTICE
-Requires-Dist: flask>=2
+Requires-Dist: flask>=2.1.0
 Requires-Dist: flask-marshmallow>=1.0.0
 Requires-Dist: marshmallow>=3.20
 Requires-Dist: webargs>=8.3
-Requires-Dist: flask-httpauth>=4
-Requires-Dist: apispec>=6
+Requires-Dist: flask-httpauth>=4.8.0
+Requires-Dist: apispec>=6.0.0
+Requires-Dist: pydantic[email]>=2.0
 Provides-Extra: dotenv
 Requires-Dist: python-dotenv; extra == "dotenv"
 Provides-Extra: async
 Requires-Dist: asgiref>=3.2; extra == "async"
 Provides-Extra: yaml
 Requires-Dist: pyyaml; extra == "yaml"
+Dynamic: license-file
 
 
 ![](https://apiflask.com/_assets/apiflask-logo.png)
@@ -49,7 +51,9 @@ Requires-Dist: pyyaml; extra == "yaml"
 
 [![Build status](https://github.com/apiflask/apiflask/actions/workflows/tests.yml/badge.svg)](https://github.com/apiflask/apiflask/actions) [![codecov](https://codecov.io/gh/apiflask/apiflask/branch/main/graph/badge.svg?token=2CFPCZ1DMY)](https://codecov.io/gh/apiflask/apiflask)
 
-APIFlask is a lightweight Python web API framework based on [Flask](https://github.com/pallets/flask) and [marshmallow-code](https://github.com/marshmallow-code) projects. It's easy to use, highly customizable, ORM/ODM-agnostic, and 100% compatible with the Flask ecosystem.
+APIFlask is a lightweight Python web API framework based on [Flask](https://github.com/pallets/flask). It's easy to use, highly customizable, ORM/ODM-agnostic, and 100% compatible with the Flask ecosystem.
+
+APIFlask supports both [marshmallow](https://github.com/marshmallow-code/marshmallow) schemas and [Pydantic](https://docs.pydantic.dev/) models through a pluggable schema adapter system, giving you the flexibility to choose the validation approach that best fits your project.
 
 With APIFlask, you will have:
 
@@ -64,8 +68,8 @@ With APIFlask, you will have:
 
 ## Requirements
 
-- Python 3.8+
-- Flask 2.0+
+- Python 3.9+
+- Flask 2.1+
 
 
 ## Installation
@@ -87,11 +91,13 @@ For Windows:
 
 - Website: <https://apiflask.com>
 - Documentation: <https://apiflask.com/docs>
+- 中文文档: <https://zh.apiflask.com/docs>
 - PyPI Releases: <https://pypi.python.org/pypi/APIFlask>
 - Change Log: <https://apiflask.com/changelog>
 - Source Code: <https://github.com/apiflask/apiflask>
 - Issue Tracker: <https://github.com/apiflask/apiflask/issues>
 - Discussion: <https://github.com/apiflask/apiflask/discussions>
+- 中文论坛: <https://codekitchen.community>
 - Twitter: <https://twitter.com/apiflask>
 - Open Collective: <https://opencollective.com/apiflask>
 
@@ -166,63 +172,70 @@ def update_pet(pet_id, json_data):
 ```
 
 <details>
-<summary>You can also use class-based views based on <code>MethodView</code></summary>
+<summary>You can use Pydantic models for type-hint based validation</summary>
 
 ```python
-from apiflask import APIFlask, Schema, abort
-from apiflask.fields import Integer, String
-from apiflask.validators import Length, OneOf
-from flask.views import MethodView
+from enum import Enum
+
+from apiflask import APIFlask, abort
+from pydantic import BaseModel, Field
 
 app = APIFlask(__name__)
 
-pets = [
-    {'id': 0, 'name': 'Kitty', 'category': 'cat'},
-    {'id': 1, 'name': 'Coco', 'category': 'dog'}
-]
 
+class PetCategory(str, Enum):
+    DOG = 'dog'
+    CAT = 'cat'
 
-class PetIn(Schema):
-    name = String(required=True, validate=Length(0, 10))
-    category = String(required=True, validate=OneOf(['dog', 'cat']))
 
+class PetOut(BaseModel):
+    id: int
+    name: str
+    category: PetCategory
 
-class PetOut(Schema):
-    id = Integer()
-    name = String()
-    category = String()
 
+class PetIn(BaseModel):
+    name: str = Field(min_length=1, max_length=50)
+    category: PetCategory
+
+
+pets = [
+    {'id': 0, 'name': 'Kitty', 'category': 'cat'},
+    {'id': 1, 'name': 'Coco', 'category': 'dog'}
+]
 
-class Hello(MethodView):
 
-    # use HTTP method name as class method name
-    def get(self):
-        return {'message': 'Hello!'}
+@app.get('/')
+def say_hello():
+    return {'message': 'Hello, Pydantic!'}
 
 
-class Pet(MethodView):
+@app.get('/pets')
+@app.output(list[PetOut])
+def get_pets():
+    return pets
 
-    @app.output(PetOut)
-    def get(self, pet_id):
-        """Get a pet"""
-        if pet_id > len(pets) - 1:
-            abort(404)
-        return pets[pet_id]
 
-    @app.input(PetIn(partial=True))
-    @app.output(PetOut)
-    def patch(self, pet_id, json_data):
-        """Update a pet"""
-        if pet_id > len(pets) - 1:
-            abort(404)
-        for attr, value in json_data.items():
-            pets[pet_id][attr] = value
-        return pets[pet_id]
+@app.get('/pets/<int:pet_id>')
+@app.output(PetOut)
+def get_pet(pet_id: int):
+    if pet_id > len(pets) or pet_id < 1:
+        abort(404)
+    return pets[pet_id - 1]
 
 
-app.add_url_rule('/', view_func=Hello.as_view('hello'))
-app.add_url_rule('/pets/<int:pet_id>', view_func=Pet.as_view('pet'))
+@app.post('/pets')
+@app.input(PetIn, location='json')
+@app.output(PetOut, status_code=201)
+def create_pet(json_data: PetIn):
+    # the validated and parsed input data will
+    # be injected into the view function as a Pydantic model instance
+    new_id = len(pets) + 1
+    new_pet = PetOut(id=new_id, name=json_data.name, category=json_data.category)
+    pets.append(new_pet)
+    return new_pet
 ```
+
 </details>
 
 <details>
@@ -252,12 +265,6 @@ See <em><a href="https://flask.palletsprojects.com/async-await">Using async and
 
 Save this as `app.py`, then run it with:
 
-```bash
-$ flask run --reload
-```
-
-Or run in debug mode:
-
 ```bash
 $ flask run --debug
 ```
@@ -331,23 +338,6 @@ def hello():
 In a word, to make Web API development in Flask more easily, APIFlask provides `APIFlask` and `APIBlueprint` to extend Flask's `Flask` and `Blueprint` objects and it also ships with some helpful utilities. Other than that, you are actually using Flask.
 
 
-## Relationship with marshmallow
-
-APIFlask accepts marshmallow schema as data schema, uses webargs to validate the request data against the schema, and uses apispec to generate the OpenAPI representation from the schema.
-
-You can build marshmallow schemas just like before, but APIFlask also exposes some marshmallow APIs for convenience:
-
-- `apiflask.Schema`: The base marshmallow schema class.
-- `apiflask.fields`: The marshmallow fields, contain the fields from both marshmallow and Flask-Marshmallow. Beware that the aliases (`Url`, `Str`, `Int`, `Bool`, etc.) were removed.
-- `apiflask.validators`: The marshmallow validators.
-
-```python
-from apiflask import Schema
-from apiflask.fields import Integer, String
-from apiflask.validators import Length, OneOf
-from marshmallow import pre_load, post_dump, ValidationError
-```
-
 ## Credits
 
 APIFlask starts as a fork of [APIFairy](https://github.com/miguelgrinberg/APIFairy) and is inspired by [flask-smorest](https://github.com/marshmallow-code/flask-smorest) and [FastAPI](https://github.com/tiangolo/fastapi) (see *[Comparison and Motivations](https://apiflask.com/comparison)* for the comparison between these projects).

{apiflask-2.3.2 → apiflask-3.0.0}/README.md

@@ -5,7 +5,9 @@
 
 [![Build status](https://github.com/apiflask/apiflask/actions/workflows/tests.yml/badge.svg)](https://github.com/apiflask/apiflask/actions) [![codecov](https://codecov.io/gh/apiflask/apiflask/branch/main/graph/badge.svg?token=2CFPCZ1DMY)](https://codecov.io/gh/apiflask/apiflask)
 
-APIFlask is a lightweight Python web API framework based on [Flask](https://github.com/pallets/flask) and [marshmallow-code](https://github.com/marshmallow-code) projects. It's easy to use, highly customizable, ORM/ODM-agnostic, and 100% compatible with the Flask ecosystem.
+APIFlask is a lightweight Python web API framework based on [Flask](https://github.com/pallets/flask). It's easy to use, highly customizable, ORM/ODM-agnostic, and 100% compatible with the Flask ecosystem.
+
+APIFlask supports both [marshmallow](https://github.com/marshmallow-code/marshmallow) schemas and [Pydantic](https://docs.pydantic.dev/) models through a pluggable schema adapter system, giving you the flexibility to choose the validation approach that best fits your project.
 
 With APIFlask, you will have:
 
@@ -20,8 +22,8 @@ With APIFlask, you will have:
 
 ## Requirements
 
-- Python 3.8+
-- Flask 2.0+
+- Python 3.9+
+- Flask 2.1+
 
 
 ## Installation
@@ -43,11 +45,13 @@ For Windows:
 
 - Website: <https://apiflask.com>
 - Documentation: <https://apiflask.com/docs>
+- 中文文档: <https://zh.apiflask.com/docs>
 - PyPI Releases: <https://pypi.python.org/pypi/APIFlask>
 - Change Log: <https://apiflask.com/changelog>
 - Source Code: <https://github.com/apiflask/apiflask>
 - Issue Tracker: <https://github.com/apiflask/apiflask/issues>
 - Discussion: <https://github.com/apiflask/apiflask/discussions>
+- 中文论坛: <https://codekitchen.community>
 - Twitter: <https://twitter.com/apiflask>
 - Open Collective: <https://opencollective.com/apiflask>
 
@@ -122,63 +126,70 @@ def update_pet(pet_id, json_data):
 ```
 
 <details>
-<summary>You can also use class-based views based on <code>MethodView</code></summary>
+<summary>You can use Pydantic models for type-hint based validation</summary>
 
 ```python
-from apiflask import APIFlask, Schema, abort
-from apiflask.fields import Integer, String
-from apiflask.validators import Length, OneOf
-from flask.views import MethodView
+from enum import Enum
+
+from apiflask import APIFlask, abort
+from pydantic import BaseModel, Field
 
 app = APIFlask(__name__)
 
-pets = [
-    {'id': 0, 'name': 'Kitty', 'category': 'cat'},
-    {'id': 1, 'name': 'Coco', 'category': 'dog'}
-]
 
+class PetCategory(str, Enum):
+    DOG = 'dog'
+    CAT = 'cat'
 
-class PetIn(Schema):
-    name = String(required=True, validate=Length(0, 10))
-    category = String(required=True, validate=OneOf(['dog', 'cat']))
 
+class PetOut(BaseModel):
+    id: int
+    name: str
+    category: PetCategory
 
-class PetOut(Schema):
-    id = Integer()
-    name = String()
-    category = String()
 
+class PetIn(BaseModel):
+    name: str = Field(min_length=1, max_length=50)
+    category: PetCategory
+
+
+pets = [
+    {'id': 0, 'name': 'Kitty', 'category': 'cat'},
+    {'id': 1, 'name': 'Coco', 'category': 'dog'}
+]
 
-class Hello(MethodView):
 
-    # use HTTP method name as class method name
-    def get(self):
-        return {'message': 'Hello!'}
+@app.get('/')
+def say_hello():
+    return {'message': 'Hello, Pydantic!'}
 
 
-class Pet(MethodView):
+@app.get('/pets')
+@app.output(list[PetOut])
+def get_pets():
+    return pets
 
-    @app.output(PetOut)
-    def get(self, pet_id):
-        """Get a pet"""
-        if pet_id > len(pets) - 1:
-            abort(404)
-        return pets[pet_id]
 
-    @app.input(PetIn(partial=True))
-    @app.output(PetOut)
-    def patch(self, pet_id, json_data):
-        """Update a pet"""
-        if pet_id > len(pets) - 1:
-            abort(404)
-        for attr, value in json_data.items():
-            pets[pet_id][attr] = value
-        return pets[pet_id]
+@app.get('/pets/<int:pet_id>')
+@app.output(PetOut)
+def get_pet(pet_id: int):
+    if pet_id > len(pets) or pet_id < 1:
+        abort(404)
+    return pets[pet_id - 1]
 
 
-app.add_url_rule('/', view_func=Hello.as_view('hello'))
-app.add_url_rule('/pets/<int:pet_id>', view_func=Pet.as_view('pet'))
+@app.post('/pets')
+@app.input(PetIn, location='json')
+@app.output(PetOut, status_code=201)
+def create_pet(json_data: PetIn):
+    # the validated and parsed input data will
+    # be injected into the view function as a Pydantic model instance
+    new_id = len(pets) + 1
+    new_pet = PetOut(id=new_id, name=json_data.name, category=json_data.category)
+    pets.append(new_pet)
+    return new_pet
 ```
+
 </details>
 
 <details>
@@ -208,12 +219,6 @@ See <em><a href="https://flask.palletsprojects.com/async-await">Using async and
 
 Save this as `app.py`, then run it with:
 
-```bash
-$ flask run --reload
-```
-
-Or run in debug mode:
-
 ```bash
 $ flask run --debug
 ```
@@ -287,23 +292,6 @@ def hello():
 In a word, to make Web API development in Flask more easily, APIFlask provides `APIFlask` and `APIBlueprint` to extend Flask's `Flask` and `Blueprint` objects and it also ships with some helpful utilities. Other than that, you are actually using Flask.
 
 
-## Relationship with marshmallow
-
-APIFlask accepts marshmallow schema as data schema, uses webargs to validate the request data against the schema, and uses apispec to generate the OpenAPI representation from the schema.
-
-You can build marshmallow schemas just like before, but APIFlask also exposes some marshmallow APIs for convenience:
-
-- `apiflask.Schema`: The base marshmallow schema class.
-- `apiflask.fields`: The marshmallow fields, contain the fields from both marshmallow and Flask-Marshmallow. Beware that the aliases (`Url`, `Str`, `Int`, `Bool`, etc.) were removed.
-- `apiflask.validators`: The marshmallow validators.
-
-```python
-from apiflask import Schema
-from apiflask.fields import Integer, String
-from apiflask.validators import Length, OneOf
-from marshmallow import pre_load, post_dump, ValidationError
-```
-
 ## Credits
 
 APIFlask starts as a fork of [APIFairy](https://github.com/miguelgrinberg/APIFairy) and is inspired by [flask-smorest](https://github.com/marshmallow-code/flask-smorest) and [FastAPI](https://github.com/tiangolo/fastapi) (see *[Comparison and Motivations](https://apiflask.com/comparison)* for the comparison between these projects).

{apiflask-2.3.2 → apiflask-3.0.0}/examples/README.md

@@ -9,7 +9,9 @@
 - Token auth example: [/examples/auth/token_auth/app.py][_token_auth]
 - Basic auth example: [/examples/auth/basic_auth/app.py][_basic_auth]
 - Dataclass example (with marshmallow-dataclass): [/examples/dataclass/app.py][_dataclass]
+- Pydantic example (with Pydantic models): [/examples/pydantic/app.py][_pydantic]
 - File upload example: [/examples/file_upload/app.py][_file_upload]
+- OpenTelemetry example: [/examples/otel/app.py][_OpenTelemetry]
 
 [_basic]: https://github.com/apiflask/apiflask/tree/main/examples/basic/app.py
 [_cbv]: https://github.com/apiflask/apiflask/tree/main/examples/cbv/app.py
@@ -20,7 +22,9 @@
 [_token_auth]: https://github.com/apiflask/apiflask/tree/main/examples/auth/token_auth/app.py
 [_basic_auth]: https://github.com/apiflask/apiflask/tree/main/examples/auth/basic_auth/app.py
 [_dataclass]: https://github.com/apiflask/apiflask/tree/main/examples/dataclass/app.py
+[_pydantic]: https://github.com/apiflask/apiflask/tree/main/examples/pydantic/app.py
 [_file_upload]: https://github.com/apiflask/apiflask/tree/main/examples/file_upload/app.py
+[_OpenTelemetry]: https://github.com/apiflask/apiflask/tree/main/examples/otel/app.py
 
 If you have built an application with APIFlask, feel free to submit a pull request to add the source link here.
 
@@ -68,6 +72,7 @@ Each example application store in a sub-folder:
 - `/openapi/static_docs`: OpenAPI example with standalone static HTML OpenAPI docs
 - `/base_response`: Base response example
 - `/dataclass`: Dataclass example (with marshmallow-dataclass)
+- `/pydantic`: Pydantic example (with Pydantic models)
 
 To run a specific example, you have to change into the corresponding folder.
 For example, if you want to run the basic example:

apiflask-3.0.0/examples/auth/apikey_auth/app.py

@@ -0,0 +1,58 @@
+import typing as t
+from flask import current_app
+from apiflask import APIFlask, APIKeyHeaderAuth, abort
+from authlib.jose import jwt, JoseError
+
+app = APIFlask(__name__)
+auth = APIKeyHeaderAuth()
+app.config['SECRET_KEY'] = 'secret-key'
+
+
+class User:
+    def __init__(self, id: int, username: str):
+        self.id = id
+        self.username = username
+
+    def get_apikey(self):
+        header = {'alg': 'HS256'}
+        payload = {'id': self.id}
+        return jwt.encode(header, payload, current_app.config['SECRET_KEY']).decode()
+
+
+users = [
+    User(1, 'lorem'),
+    User(2, 'ipsum'),
+]
+
+
+def get_user_by_id(id: int) -> t.Union[User, None]:
+    return tuple(filter(lambda u: u.id == id, users))[0]
+
+
+@auth.verify_token
+def verify_apikey(apikey: str) -> t.Union[User, None]:
+    try:
+        data = jwt.decode(
+            apikey.encode('ascii'),
+            current_app.config['SECRET_KEY'],
+        )
+        id = data['id']
+        user = get_user_by_id(id)
+    except JoseError:
+        return None
+    except IndexError:
+        return None
+    return user
+
+
+@app.post('/apikey/<int:id>')
+def get_token(id: int):
+    if get_user_by_id(id) is None:
+        abort(404)
+    return {'api_key': f'{get_user_by_id(id).get_apikey()}'}
+
+
+@app.get('/name')
+@app.auth_required(auth)
+def get_username():
+    return auth.current_user.username

apiflask-3.0.0/examples/auth/multi_auth/app.py

@@ -0,0 +1,78 @@
+import typing as t
+
+from flask import current_app
+from apiflask import APIFlask, HTTPBasicAuth, HTTPTokenAuth, MultiAuth, Schema, abort
+from werkzeug.security import generate_password_hash, check_password_hash
+from apiflask.fields import String
+from authlib.jose import jwt, JoseError
+
+app = APIFlask(__name__)
+basic_auth = HTTPBasicAuth()
+token_auth = HTTPTokenAuth()
+multi_auth = MultiAuth(basic_auth, token_auth)
+app.config['SECRET_KEY'] = 'secret-key'
+
+
+class User:
+    def __init__(self, id: int, username: str, password: str):
+        self.id = id
+        self.username = username
+        self.password = generate_password_hash(password)
+
+    def get_token(self):
+        header = {'alg': 'HS256'}
+        payload = {'id': self.id}
+        return jwt.encode(header, payload, current_app.config['SECRET_KEY']).decode()
+
+
+users = [
+    User(1, 'lorem', 'foo'),
+    User(2, 'ipsum', 'bar'),
+]
+
+username_map = {user.username: user for user in users}
+
+
+def get_user_by_id(id: int) -> t.Union[User, None]:
+    return tuple(filter(lambda u: u.id == id, users))[0]
+
+
+@basic_auth.verify_password
+def verify_password(username: str, password: str) -> t.Union[User, None]:
+    if username in username_map and check_password_hash(username_map[username].password, password):
+        return username_map[username]
+    return None
+
+
+@token_auth.verify_token
+def verify_token(token: str) -> t.Union[User, None]:
+    try:
+        data = jwt.decode(
+            token.encode('ascii'),
+            current_app.config['SECRET_KEY'],
+        )
+        id = data['id']
+        user = get_user_by_id(id)
+    except JoseError:
+        return None
+    except IndexError:
+        return None
+    return user
+
+
+class Token(Schema):
+    token = String()
+
+
+@app.post('/token/<int:id>')
+@app.output(Token)
+def get_token(id: int):
+    if get_user_by_id(id) is None:
+        abort(404)
+    return {'token': f'Bearer {get_user_by_id(id).get_token()}'}
+
+
+@app.route('/')
+@app.auth_required(multi_auth)
+def index():
+    return f'Hello, {multi_auth.current_user.username}'

{apiflask-2.3.2 → apiflask-3.0.0}/examples/auth/token_auth/app.py

@@ -59,7 +59,7 @@ def get_token(id: int):
     return {'token': f'Bearer {get_user_by_id(id).get_token()}'}
 
 
-@app.get('/name/<int:id>')
+@app.get('/name')
 @app.auth_required(auth)
-def get_secret(id):
+def get_secret():
     return auth.current_user.secret