Apiflask

Released: --

Released: 2024/3/10

- Reuse the `File`, `Config` field, and file-related validators from flask-marshmallow ([issue 540][issue_540]).
- Add support for a `--quiet` option to the `flask spec` command ([issue 548][issue_548]).
- Fix the `flask spec` command for validators operating on complex data types ([issue 547][issue_547]).

[issue_540]: https://github.com/apiflask/apiflask/issues/540
[issue_548]: https://github.com/apiflask/apiflask/issues/548
[issue_547]: https://github.com/apiflask/apiflask/issues/547

Released: 2023/12/16

- Add `FileType` and `FileSize` validators ([issue 253][issue_253]).
- Allow adding multiple media types for a response ([issue 494][issue_494]).
- Support adding headers to the response schema ([issue 507][issue_507]).
- Add support for adding decorators to the OpenAPI spec and documentation UI endpoints ([issue 483][issue_483]).
- Fix the base repsonse schema inconsistency issue.

[issue_494]: https://github.com/apiflask/apiflask/issues/494
[issue_507]: https://github.com/apiflask/apiflask/issues/507
[issue_483]: https://github.com/apiflask/apiflask/issues/483
[issue_253]: https://github.com/apiflask/apiflask/issues/253

Released: 2023/9/24

- Loose Flask version requirement to >= 2.0.0 and add test
for minimum dependency versions ([issue 478][issue_478]).
- Add file uploading example application ([pr 476][pr_476]).
- Fix token authentication example application ([pr 472][pr_472]).

[issue_478]: https://github.com/apiflask/apiflask/issues/478
[pr_476]: https://github.com/apiflask/apiflask/pull/476
[pr_472]: https://github.com/apiflask/apiflask/pull/472

Released: 2023/8/15

- Add `Config` field to dump Flask `app.config` variables ([issue 468][issue_468]).
- Fix the typing of newly updated `doc(responses)` parameter ([issue 466][issue_466]).

[issue_466]: https://github.com/apiflask/apiflask/issues/466
[issue_468]: https://github.com/apiflask/apiflask/issues/468

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.

- Drop Python 3.7 support.
- Drop Flask 1.x support ([issue 442][issue_442]).
- Only pass keyword arguments to the view function. The argument name
of the parsed data from `app.input()` will be `{location}_data` or the
value of `arg_name` ([issue 427][issue_427]).
- Add `FileSchema` to generate OpenAPI file response ([issue 447][issue_447]).
- Support using `{}` to represent not only empty body (204) but also empty schema.
Use `{}` or `EmptySchema` will not set the status code to 204 anymore.
- Remove the previously deprecated code:
- The `tag` parameter in `app.doc`.
- The `role` parameter in `app.auth_required`.
- The `redoc_path` parameter in `apiflask.APIFlask` and the `/redoc` path.
- Support setting a complete response OpenAPI spec throught the `app.doc(responses)`
parameter (i.e. `responses={400: {'description': '', 'content': ...}}`)
([issue 327][issue_327]).

[issue_327]: https://github.com/apiflask/apiflask/issues/327
[issue_427]: https://github.com/apiflask/apiflask/issues/427
[issue_442]: https://github.com/apiflask/apiflask/issues/442
[issue_447]: https://github.com/apiflask/apiflask/issues/447