Apiflask

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

Released: 2023/3/27

- Fix the import error when calling `apispec.yaml_utils.dict_to_yaml`
([issue 419][issue_419]).

[issue_419]: https://github.com/apiflask/apiflask/issues/419

Released: 2023/3/18

- Add `scurity_scheme_name` for `HTTPBasicAuth` and `HTTPTokenAuth` to define custom
OpenAPI security scheme name ([issue 410][issue_410]).
- Add config `SPEC_PROCESSOR_PASS_OBJECT` to control the argument type of
spec processor. The `spec` argument will be an `apispec.APISpec` object
when this config is `True` ([issue 213][issue_213]).
- Add `content_type` parameter to the `output()` decorator to customize the
response's content/media type.

[issue_410]: https://github.com/apiflask/apiflask/issues/410
[issue_357]: https://github.com/apiflask/apiflask/issues/357
[issue_213]: https://github.com/apiflask/apiflask/issues/213

Released: 2023/2/21

- Bypass OpenAPI spec generation for view methods ([issue 406][issue_406]).

[issue_406]: https://github.com/apiflask/apiflask/issues/406

Released: 2023/2/18

- Remove the validation of input locations ([issue 259][issue_259]).
- Support passing `Function` type config to `SWAGGER_UI_CONFIG` ([issue 381][issue_381]).
- Fix the base response support so that a custom class can be returned from
the view function ([issue 384][issue_384]).

[issue_259]: https://github.com/apiflask/apiflask/issues/259
[issue_381]: https://github.com/apiflask/apiflask/issues/381
[issue_384]: https://github.com/apiflask/apiflask/issues/384

Released: 2023/1/15

- Support to generate the OpenAPI `servers` field when the reqeust context is available. Add
the config `AUTO_SERVERS` to control this automation behavior ([issue 377][issue_377]).

[issue_377]: https://github.com/apiflask/apiflask/issues/377