Apiflask

Released: 2021/11/26

- Fix missing headers for JSON error responses when catching Werkzeug exceptions ([issue 173][issue_173]).

[issue_173]: https://github.com/apiflask/apiflask/issues/173

Released: 2021/9/19

- Support using `add_url_rule` method on view classes ([issue 110][issue_110]).
- Revoke the undocumented name changes on `validates` and `validates_schema` from marshmallow ([issue 62][issue_62]).
- Only expose marshmallow `fields`, `validators`, and `Schema` in APIFlask.
- Remove the `status_code` field from the default error response ([issue 124][issue_124]).
- Add parameter `extra_data` to `abort` and `HTTPError`, it accepts a dict that will be added
to the error response ([issue 125][issue_125]).
- Support passing `operation_id` in the `doc` decorator. The auo-generating of operationId
can be enabled with config `AUTO_OPERATION_ID`, defaults to `False` ([pull 131][pull_131]).
- Support setting response links via `output(links=...)` ([issue 138][issue_138]).

[issue_110]: https://github.com/apiflask/apiflask/issues/110
[issue_62]: https://github.com/apiflask/apiflask/issues/62
[issue_124]: https://github.com/apiflask/apiflask/issues/124
[issue_125]: https://github.com/apiflask/apiflask/issues/125
[pull_131]: https://github.com/apiflask/apiflask/pull/131
[issue_138]: https://github.com/apiflask/apiflask/issues/138

Released: 2021/8/10

- Support base response schema customization, add config `BASE_RESPONSE_SCHEMA`
and `BASE_RESPONSE_DATA_KEY` ([issue 65][issue_65]).
- Support setting custom schema name resolver via the `APIFlask.schema_name_resolver`
attribute ([issue 105][issue_105]).
- Improve error handling ([issue 107][issue_107]):
- Authentication error now calls app error processor function when `APIFlask(json_errors=True)`.
The default HTTP reason phrase is used for auth errors.
- Always pass an `HTTPError` instance to error processors. When you set a custom error
processor, now you need to accept an `HTTPError` instance as the argument. The `detail` and
`headers` attribute of the instance will be empty dict if not set.
- Add an `error_processor` decorator for `HTTPTokenAuth` and `HTTPBasicAuth`, it can be used
to register a custom error processor for auth errors.
- Support to config Redoc via the configuration variable `REDOC_CONFIG` ([issue 121][issue_121]).

[issue_65]: https://github.com/apiflask/apiflask/issues/65
[issue_105]: https://github.com/apiflask/apiflask/issues/105
[issue_107]: https://github.com/apiflask/apiflask/issues/107
[issue_121]: https://github.com/apiflask/apiflask/issues/121

Released: 2021/7/7

- Automatically add a 404 response in OpenAPI spec for routes contains URL
variables ([issue 78][issue_78]).
- Rename the private method `app.get_spec` to `app._get_spec`, add new
parameter `force_update`. The `app.spec` property now will always return
the latest spec instead of the cached one ([issue 79][issue_79]).
- Support using `doc(responses={<STATUS_CODE>: <DESCRIPTION>})` to overwrite
existing response descriptions.
- Add configration variable `INFO` (and `app.info` attribute), it can be used
to set the following info fields: `description`, `termsOfService`, `contact`,
`license` ([issue 98][issue_98]).
- Rename the following configuration variables ([issue 99][issue_99]):
- `AUTO_PATH_SUMMARY` -> `AUTO_OPERATION_SUMMARY`
- `AUTO_PATH_DESCRIPTION` -> `AUTO_OPERATION_DESCRIPTION`

[issue_78]: https://github.com/apiflask/apiflask/issues/78
[issue_79]: https://github.com/apiflask/apiflask/issues/79
[issue_98]: https://github.com/apiflask/apiflask/issues/98
[issue_99]: https://github.com/apiflask/apiflask/issues/99

Released: 2021/6/24

- Support using async error processor and async spec processor
([pull 57][pull_57]).
- Fix auto-tag support for nesting blueprint ([pull 58][pull_58]).
- Support set the URL prefix of the OpenAPI blueprint with the
`openapi_blueprint_url_prefix` argument ([pull 64][pull_64]).
- Add a `flask spec` command to output the OpenAPI spec to stdout
or a file, also add new config `LOCAL_SPEC_PATH` and
`LOCAL_SPEC_JSON_INDENT` ([issue 61][issue_61]).
- Re-add the `SPEC_FORMAT` config. Remove the auto-detection of
the format from `APIFlask(spec_path=...)`, now you have to set the
format explicitly with the `SPEC_FORMAT` config ([issue 67][issue_67]).
- Support to sync the local OpenAPI spec automatically. Add new config
`SYNC_LOCAL_SPEC` ([issue 68][issue_68]).
- Change the default value of config `DOCS_FAVICON` to
`'https://apiflask.com/_assets/favicon.png'`, set to `None` to disable
the favicon.
- OpenAPI UI templates are move to `ui_templates.py`.
- Revert the renames on pre/post decorators from marshmallow ([issue 62][issue_62]).
- Change the default branch to "main".
- Move the source to the "src" directory.
- Enable pre-commit.

[pull_57]: https://github.com/apiflask/apiflask/pull/57
[pull_58]: https://github.com/apiflask/apiflask/pull/58
[pull_64]: https://github.com/apiflask/apiflask/pull/64
[issue_61]: https://github.com/apiflask/apiflask/issues/61
[issue_62]: https://github.com/apiflask/apiflask/issues/62
[issue_67]: https://github.com/apiflask/apiflask/issues/67
[issue_68]: https://github.com/apiflask/apiflask/issues/68

Released: 2021/5/17

- Improve static request dispatch ([pull 54][pull_54]).

[pull_54]: https://github.com/apiflask/apiflask/pull/54