Apiflask

Released: 2021/5/11

- Support using the `output` decorator on async views ([pull 41][pull_41]).
- Add `PaginationSchema` and `pagination_builder` as basic pagination support
([pull 42][pull_42]).
- Import and rename the decorators from marshmallow ([pull 43][pull_43]).
- Rename `utils` module to `helpers` ([pull 44][pull_44]).
- Add `default` parameter for `get_reason_phrase` ([pull 45][pull_45]).

[pull_41]: https://github.com/apiflask/apiflask/pull/41
[pull_42]: https://github.com/apiflask/apiflask/pull/42
[pull_43]: https://github.com/apiflask/apiflask/pull/43
[pull_44]: https://github.com/apiflask/apiflask/pull/44
[pull_45]: https://github.com/apiflask/apiflask/pull/45

Released: 2021/4/29

- Allow returning a `Response` object in a view function decorated with the `output`
decorator. In this case, APIFlask will do nothing but return it directly
([pull 38][pull_38]).
- Skip Flask's `Blueprint` object when generating the OpenAPI spec ([pull 37][pull_37]).

[pull_38]: https://github.com/apiflask/apiflask/pull/38
[pull_37]: https://github.com/apiflask/apiflask/pull/37

Released: 2021/4/28

- Change the default endpoint of the view class to the original class name
([pull 36][pull_36]).
- Allow passing the `methods` argument for the `route` decorator on view classes.

[pull_36]: https://github.com/apiflask/apiflask/pull/36

Released: 2021/4/27

- Remove the support to generate `info.description` and tag description from module
docstring, and also remove the `AUTO_DESCRIPTION` config ([pull 30][pull_30]).
- Remove the configuration variable `DOCS_HIDE_BLUEPRINTS`, add `APIBlueprint.enable_openapi`
as a replacement.
- Support class-based views, now the `route` decorator can be used on `MethodView` class.
Other decorators (i.e., `input`, `output`, etc.) can be used on view methods
(i.e., `get()`, `post()`, etc.) ([pull 32][pull_32]).
- No longer support to mix the use of `flask.Bluerpint` and `apiflask.APIBluerpint`.
- Support to use the `auth_required` decorator on app-wide `before_request` functions
([pull 34][pull_34]).

[pull_30]: https://github.com/apiflask/apiflask/pull/30
[pull_32]: https://github.com/apiflask/apiflask/pull/32
[pull_34]: https://github.com/apiflask/apiflask/pull/34

Released: 2021/4/20

- Merge the following configuration variables to `SUCCESS_DESCRIPTION` ([pull 7][pull_7]):
- `DEFAULT_2XX_DESCRIPTION`
- `DEFAULT_200_DESCRIPTION`
- `DEFAULT_201_DESCRIPTION`
- `DEFAULT_204_DESCRIPTION`
- Remove the following configuration variables ([pull 7][pull_7]):
- `AUTO_HTTP_ERROR_RESPONSE`
- `AUTH_ERROR_SCHEMA`
- Add new configuration variables `YAML_SPEC_MIMETYPE` and `JSON_SPEC_MIMETYPE` to support
to customize the MIME type of spec response ([pull 3][pull_3]).
- Remove configuration variable `SPEC_TYPE`.
- Fix the support to pass an empty dict as schema for 204 response ([pull 12][pull_12]).
- Support set multiple examples for request/response body with `output(examples=...)`
and `iniput(examples=...)` ([pull 23][pull_23]).
- Add `auth_required(roles=...)` and `doc(tags=...)` parameters for list value, `role` and
`tag` parameter now only accept string value ([pull 26][pull_26]).
- Add new configuration variable `OPENAPI_VERSION` to set the version of OAS
([pull 27][pull_27]).
- Rename `abort_json()` to `abort()` ([pull 29][pull_29]).

[pull_3]: https://github.com/apiflask/apiflask/pull/3
[pull_12]: https://github.com/apiflask/apiflask/pull/12
[pull_7]: https://github.com/apiflask/apiflask/pull/7
[pull_23]: https://github.com/apiflask/apiflask/pull/23
[pull_26]: https://github.com/apiflask/apiflask/pull/26
[pull_27]: https://github.com/apiflask/apiflask/pull/27
[pull_29]: https://github.com/apiflask/apiflask/pull/29

Released: 2021/3/31

- First public version.
- Add type annotations and enable type check in tox ([commit](https://github.com/apiflask/apiflask/commit/5cbf27ecbb4318a9fd177307a52146aa993f86c8)).
- Refactor the APIs ([commit](https://github.com/apiflask/apiflask/commit/d149c0c0ee90a7120e6ede1c3e09715c944bb704)):
- Change base class `scaffold.Scaffold` to class decorator `utils.route_shortcuts`.
- Merge the `_OpenAPIMixin` class into `APIFlask` class.
- Turn `security._AuthErrorMixin` into `handle_auth_error` function.
- Add explicit parameter `role` and `optional` for `auth_required` decorator.
- Rename module `errors` to `exceptions`.
- Rename `api_abort()` to `abort_json()`.
- Rename `get_error_message()` to `get_reason_phrase()` and move it to `utils` module.
- Update the default value of config `AUTH_ERROR_DESCRIPTION`.
- Add `validators` module.
- Change `doc(tags)` to `doc(tag)`.
- Support to pass a dict schema in `output` decorator ([commit](https://github.com/apiflask/apiflask/commit/e82fd168faf5f04871e549ebe22c63e66270bd1b)).
- Support to pass a dict schema in `input` decorator ([commit](https://github.com/apiflask/apiflask/commit/f9c2c441363ddf4720800e0d3fc3d0e9cc28fe81)).
- Check if the status code is valid for `abort_json` and `HTTPError` ([commit](https://github.com/apiflask/apiflask/commit/20077dea0e82f123a3d2fc50c2ec529346215789)).
- Add basic docstrings to generate the API reference documentation ([commit](https://github.com/apiflask/apiflask/commit/6d65a25ab4de9d623e22575d4d5476abdc50cbc0)).
- Support to set custom example for request/response body ([commit](https://github.com/apiflask/apiflask/commit/638fa9c5680944d6454a4dbafe8abb152525d91c)).