Apiflask

Released: 2023/1/8

- **[Breaking change]** Add `apiflask.views.MethodView` to replace `flask.views.MethodView`, raise error if
using `flask.views.MethodView` ([issue 341][issue_341]).
- **[Breaking change]** Change the status code of request validation error from 400 to 422 ([issue 345][issue_345]).
- Add `Enum` field from marshmallow 3.18.
- Fix OpenAPI spec generating for path parameters when path schema is provided ([issue 350][issue_350]).
- Add `spec_plugins` param to `APIFlask` class to support using custom apispec plugins ([issue 349][issue_349]).
- Improve the default bypassing rules to support bypass blueprint's static endpoint and
Flask-DebugToolbar ([issue 344][issue_344], [issue 369][issue_369]).
- Explicitly check if `view_func.view_class` is `MethodViewType` in `add_url_rule` ([issue 379][issue_379]).
- The schema fields are now in order by default, which ensures the output of `flask spec` is deterministic
([issue 373][issue_373]).

[issue_350]: https://github.com/apiflask/apiflask/issues/350
[issue_349]: https://github.com/apiflask/apiflask/issues/349
[issue_345]: https://github.com/apiflask/apiflask/issues/345
[issue_344]: https://github.com/apiflask/apiflask/issues/344
[issue_369]: https://github.com/apiflask/apiflask/issues/369
[issue_379]: https://github.com/apiflask/apiflask/issues/379
[issue_373]: https://github.com/apiflask/apiflask/issues/373
[issue_341]: https://github.com/apiflask/apiflask/issues/341

Released: 2022/9/4

- Fix some tests and import statements for Flask 2.2 ([pr 343][pr_343]).
- Pin Flask < 2.2 as a temp fix for the breaking changes of class-based view support ([issue 341][issue_341]).

[pr_343]: https://github.com/apiflask/apiflask/pull/343
[issue_341]: https://github.com/apiflask/apiflask/issues/341

Released: 2022/8/13

- Set default Elements router to `hash` to fix incorrect path updates.

Released: 2022/8/3

- Improve CI setup and test again Python 3.10 and 3.11.
- Fix the typing of `APIFlask` path parameters ([issue 329][issue_329]).
- Update `MethodViewType` usages for Flask 2.2 ([issue 335][issue_335]).

[issue_329]: https://github.com/apiflask/apiflask/issues/329
[issue_335]: https://github.com/apiflask/apiflask/issues/335

Released: 2022/7/3

- Add a versioned docs for 1.x releases (https://v1.apiflask.com).
- Allow the view function to return a list as JSON response ([issue 321][issue_321]).
- Add new docs UI support: RapiDoc, RapiPDF, and Elements ([pr 308][pr_308]).
- Add a `docs_ui` parameter to APIFlask to set the API docs UI (can be
`swagger-ui` (default), `redoc`, `rapidoc`, and `rapipdf`).
- Deprecate the separate docs path `/redoc` and the `redoc_path` parameter.
- Add the following configuration variables for new docs support:
- `ELEMENTS_JS`
- `ELEMENTS_CSS`
- `ELEMENTS_LAYOUT`
- `ELEMENTS_CONFIG`
- `RAPIDOC_JS`
- `RAPIDOC_THEME`
- `RAPIDOC_CONFIG`
- `RAPIPDF_JS`
- `RAPIPDF_CONFIG`
- Fix CLI entry point setup to prevent overwriting `flask`
([issue 312][issue_312])

[pr_308]: https://github.com/apiflask/apiflask/pull/308
[issue_312]: https://github.com/apiflask/apiflask/issues/312
[issue_321]: https://github.com/apiflask/apiflask/issues/321

Released: 2022/5/21

- Combine custom security schemes (app.security_schemes) with existing values
([issue 293][issue_293]).
- Add the missing `path` (`view_args`) to the valid request `location` list
([issue 301][issue_301])
- Fix the security scheme values to lowercase.

[issue_293]: https://github.com/apiflask/apiflask/issues/293
[issue_301]: https://github.com/apiflask/apiflask/issues/301