Skip to content

APIFlask Change Log

Upgrade to the latest version:

$ pip install -U apiflask

or check the current installed version first:

$ pip show apiflask

Version 0.5.0

Released: - 0.5.0 plan: https://github.com/greyli/apiflask/issues/25

  • Remove the support to generate info.description and tag description from module docstring, and also remove the AUTO_DESCRIPTION config (pull #30).

Version 0.4.0

Released: 2021/4/20

  • Merge the following configuration variables to SUCCESS_DESCRIPTION (pull #7):
    • DEFAULT_2XX_DESCRIPTION
    • DEFAULT_200_DESCRIPTION
    • DEFAULT_201_DESCRIPTION
    • DEFAULT_204_DESCRIPTION
  • Remove the following configuration variables (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).
  • Remove configuration variable SPEC_TYPE.
  • Fix the support to pass an empty dict as schema for 204 response (pull #12).
  • Support set multiple examples for request/response body with @output(examples=...) and @iniput(examples=...) (pull #23).
  • Add auth_required(roles=...) and doc(tags=...) parameters for list value, role and tag parameter now only accept string value (pull #26).
  • Add new configuration variable OPENAPI_VERSION to set the version of OAS (pull #27).
  • Rename abort_json() to abort() (pull #29).

Version 0.3.0

Released: 2021/3/31

  • First public version.
  • Add type annotations and enable type check in tox (commit).
  • Refactor the APIs (commit):
    • 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).
  • Support to pass a dict schema in @input decorator (commit).
  • Check if the status code is valid for abort_json and HTTPError (commit).
  • Add basic docstrings to generate the API reference documentation (commit).
  • Support to set custom example for request/response body (commit).

Version 0.2.0

Released: 2021-3-27

  • Fix various bugs.
  • Refactor the package and tests (100% coverage).
  • Rename most of the APIs.
  • Add new APIs:
    • APIFlask
    • APIBlueprint
    • HTTPError
    • api_json
    • HTTPTokenAuth
    • HTTPBasicAuth
    • @doc
    • EmptySchema
  • Add a bunch of new configuration variables:
    • DESCRIPTION
    • TAGS
    • CONTACT
    • LICENSE
    • SERVERS
    • EXTERNAL_DOCS
    • TERMS_OF_SERVICE
    • SPEC_FORMAT
    • AUTO_TAGS
    • AUTO_DESCRIPTION
    • AUTO_PATH_SUMMARY
    • AUTO_PATH_DESCRIPTION
    • AUTO_200_RESPONSE
    • DEFAULT_2XX_DESCRIPTION
    • DEFAULT_200_DESCRIPTION
    • DEFAULT_201_DESCRIPTION
    • DEFAULT_204_DESCRIPTION
    • AUTO_VALIDATION_ERROR_RESPONSE
    • VALIDATION_ERROR_STATUS_CODE
    • VALIDATION_ERROR_DESCRIPTION
    • VALIDATION_ERROR_SCHEMA
    • AUTO_AUTH_ERROR_RESPONSE
    • AUTH_ERROR_STATUS_CODE
    • AUTH_ERROR_DESCRIPTION
    • AUTH_ERROR_SCHEMA
    • AUTO_HTTP_ERROR_RESPONSE
    • HTTP_ERROR_SCHEMA
    • DOCS_HIDE_BLUEPRINTS
    • DOCS_FAVICON
    • REDOC_USE_GOOGLE_FONT
    • REDOC_STANDALONE_JS
    • SWAGGER_UI_CSS
    • SWAGGER_UI_BUNDLE_JS
    • SWAGGER_UI_STANDALONE_PRESET_JS
    • SWAGGER_UI_LAYOUT
    • SWAGGER_UI_CONFIG
    • SWAGGER_UI_OAUTH_CONFIG
  • Support to hide blueprint from API docs with config DOCS_HIDE_BLUEPRINTS (commit)
  • Support to deprecate and hide an endpoint with doc(hide=True, deprecated=True)(commit)
  • Support to customize the API docs with various configuration variables. (commit)
  • Support to set all fields of OpenAPI object and Info object (commit)
  • Support YAML format spec (commit)
  • Automatically register a validation error response for endpoints which use @input. (commit)
  • Automatically register a authorization error response for endpoints which use @auth_required. (commit)
  • Automatically add response schema for responses added with @doc(responses=...). (commit)
  • Pass view arguments to view function as positional arguments (commit)
  • Require Python 3.7 to use ordered dict (commit)
  • Add shortcuts for app.route: app.get(), app.post(), etc. (commit)
  • Not an extension any more (commit)

Version 0.1.0

Released: 2021-1-27

  • Add view functions without response schema into spec (commit)
  • Set default response descriptions (commit)
  • Stop rely on Flask-Marshmallow (commit)
  • Change default spec path to openapi.json (commit)
  • Add support for enabling Swagger UI and Redoc at the same time (commit)
  • Change default spec title and version (commit)
  • Support auto generating summary from function name (commit)
  • Start as a fork of APIFairy 0.6.2 at 2021-01-13.