• fixes #242

Checklist:

• [x] Add tests that demonstrate the correct behavior of the change. Tests should fail without the change.
• [x] Add or update relevant docs, in the docs folder and in code docstring.
• [ ] Add an entry in CHANGES.md summarizing the change and linking to the issue and your username.
• [ ] Add *Version changed* or *Version added* note in any relevant docs and docstring.
• [x] Run pytest and tox, no tests failed.

• fixes #379

Checklist:

• [X] Add tests that demonstrate the correct behavior of the change. Tests should fail without the change.
• [ ] Add or update relevant docs, in the docs folder and in code docstring.
• [X] Add an entry in CHANGES.md summarizing the change and linking to the issue and your username.
• [ ] Add *Version changed* or *Version added* note in any relevant docs and docstring.
• [X] Run pytest and tox, no tests failed.

Implemented a fixture for the "skip async test" function since all test in that file will requires Flask > 2.0 suggested by jonasps and greyli apiflask/tests/test_async.py Before

def skip_flask1(app):
    if not hasattr(app, 'ensure_sync'):
        pytest.skip('This test requires Flask 2.0 or higher')

After

@pytest.fixture(autouse=True)
def skip_async_test(app):
    if not hasattr(app, 'ensure_sync'):
        pytest.skip('This test requires Flask 2.0 or higher')

To improve it

• fixes #318

Checklist:

• [x] Add tests that demonstrate the correct behavior of the change. Tests should fail without the change.
• [ ] Add or update relevant docs, in the docs folder and in code docstring.
• [ ] Add an entry in CHANGES.md summarizing the change and linking to the issue and your username.
• [ ] Add *Version changed* or *Version added* note in any relevant docs and docstring.
• [ ] Run pytest and tox, no tests failed.

See this discussion where Grey says:

Glad to see this finally merged! After I proposed this idea and was declined in the first pallets meeting, I started to make the REST API extension I'm developing to become a framework so that I can inherit the Flask class and add these route shortcuts, now I may consider making it back to an extension...

Motivation

So that we can healthily mix different extensions and not make APIFlask our main point of entry.

I have some doubt about these changes, so I keep it as a undocumentated features so far. Basically, I change the name of the following decorators from Marshamallow:

• validates -> validate
• validates_schema -> validate_schema
• ~~pre_load -> before_load~~
• ~~post_load -> after_load~~
• ~~pre_dump -> before_dump~~
• ~~post_dump -> after_dump~~

Some ideas behind these changes:

• validate and validate_schema are short and clear than validates and validates_schema. It also matches the validate keyword in field classes.
• ~~The change from pre_ to before_ and from post_ to after_ was trying to follow the name convention in Flask (before_request, etc.).~~

IMO, the new names are easier to understand and intuitive. However, this will definitely introduce "breaking" changes between APIFlask and Marshmallow. I can add a warning in the docs to inform users that they can continue to import everything from marshmallow, but notice the name changes if they want to import from APIFlask.

Is it a good or bad idea? Feel free to leave any thoughts.

Error when using class-based views for compliance documentation

from flask.views import MethodView
from apiflask import APIFlask

app = APIFlask(__name__)


@app.route('/pets/<int:pet_id>', endpoint='pet')
class Pet(MethodView):

    def get(self, pet_id):
        return {'message': 'OK'}

    def delete(self, pet_id):
        return '', 204

app.run(debug=True)

Environment:

• Python version: 3.10
• Flask version: 2.2.2
• APIFlask version: 1.1.2

Now apiflask supports multiple @app.output decorators

• fixes #327

    @app.route("/lessons", methods=['GET'])
    @app.input(LessonsRequestSchema, location="querystring")
    @app.output(LessonSchema, 201, description="Single lesson")
    @app.output(LessonsResponseSchema, 244, description="list of lessons")
    def lessons(query):
        #implementation goes here
        pass
  

When I generate the specs without specifying any tags the output yaml format get inconsistent. In particular, in many case is correct:

      tags:
      - Supercon

with Supercon as the name of the application

However, for certain cases (see the whole method):

@bp.route('/record/<id>/flag', methods=['PUT', 'PATCH'])
@output(Flag)
def flag_record(id):
    object_id = validateObjectId(id)
    connection = connect_mongo(config=config)
    db_name = config['mongo']['db']
    db = connection[db_name]
    tabular_collection = db.get_collection("tabular")
    record = tabular_collection.find_one({"_id": object_id})
    if record is None:
        return 404
    else:
        new_status = 'invalid'
        new_type = 'manual'

        changes = {'status': new_status, 'type': new_type}

        tabular_collection.update_one({'_id': record['_id']}, {'$set': changes})
        return changes, 200

the array is invalidated:

  /supercon/record/{id}/flag:
    patch:
      parameters:
      - &id001
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Flag'
          description: Successful response
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Not found
      summary: Flag Record
      tags: &id002
      - Supercon
    put:
      parameters:
      - *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Flag'
          description: Successful response
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Not found
      summary: Flag Record
      tags: *id002

if I define the app.tags("supercon") the problem disappears..

Environment:

• Python version: 3.8.12
• Flask version: 2.0.2
• APIFlask version: 0.11.0

the BASE_RESPONSE_SCHEMA not use in APIBlueprint

class BaseResponseSchema(Schema):
    message = String()
    status_code = Integer()
    data = Field()  # the data key

app.config['BASE_RESPONSE_SCHEMA'] = BaseResponseSchema
app.config['BASE_RESPONSE_DATA_KEY '] = 'data'

just return the data, like this

{
    "data": {
        "category": "dog",
        "id": 3,
        "name": "admin13"
    }
}

I can’t determine whether it’s a bug or a problem with my settings

Running flask spec --output openapi.yaml repeatedly results in output files with diffs when working on a large project. This is problematic when consuming the output file to generate an HTTP client.

Environment:

• Python version: 3.9.13
• Flask version: 2.0.3
• APIFlask version: 1.1.3

• fixes #344

Checklist:

• [ ] Add tests that demonstrate the correct behavior of the change. Tests should fail without the change.
• [x] Add or update relevant docs, in the docs folder and in code docstring.
• [ ] Add an entry in CHANGES.md summarizing the change and linking to the issue and your username.
• [ ] Add *Version changed* or *Version added* note in any relevant docs and docstring.
• [x] Run pytest and tox, no tests failed.

If BASE_RESPONSE_SCHEMA is set and a non-dict like object is returned from a route, an exception TypeError: argument of type '<type of object>' is not iterable is thrown from scaffold.py when checking if data_key not in obj (the in keyword doesn't work on all objects).

Environment:

• Python version:
• Flask version:
• APIFlask version:

I tried to provide the "requestInterceptor" option to Swagger UI via SWAGGER_UI_CONFIG, but it did not work. The basic problem seems to be that apiflask assumes that all such options should be strings, but this is not the case for this option. If only some of the options are supported, this should be documented.

To reproduce, take your own example program and add the lines

app.config['SWAGGER_UI_CONFIG'] = {
   'requestInterceptor': "(req) => { console.log('intercepted!'); return req; }"
}

Navigate to the docs page and it fails with the error "r.requestInterceptor is not a function /openapi.json" But there does not seem to be any way to make it into a function in my Python code. I have done something similar in C# with Swashbuckle, where it works fine to provide it as a string in this way.

In ui_templates.py in apiflask are the lines

var userConfig = {{ config.SWAGGER_UI_CONFIG | tojson }}
   for (var attr in userConfig) {
     baseConfig[attr] = userConfig[attr]
   }

which seems to just assume that all options are meant to be strings. If I change this to eval(userConfig[attr]) then it works (but would then not work for options that are meant to be strings rather than javascript code, so some kind of conditional logic would be needed. )

Environment:

• Python 3.10.6
• Flask version 2.1.3
• APIFlask version: 1.1.3

Code

from apiflask import APIFlask

app = APIFlask(__name__)


@app.get('/')
def ping():
    return 'pong\n'


if __name__ == '__main__':
    app.run()

nginx.conf

http {
    server {
        listen       80;
        server_name  localhost;

        location ^~ /project/v1/ {
            proxy_pass http://127.0.0.1:5000/;
        }
    }
}

Correct：http://127.0.0.1/project/v1/

Error：http://127.0.0.1/project/v1/docs

pyinstaller

Traceback (most recent call last): File "werkzeug\utils.py", line 556, in import_string AttributeError: module 'apiflask' has no attribute 'settings'

During handling of the above exception, another exception occurred:

Traceback (most recent call last): File "werkzeug\utils.py", line 558, in import_string ImportError: module 'apiflask' has no attribute 'settings'

During handling of the above exception, another exception occurred:

Traceback (most recent call last): File "manage.py", line 22, in File "apiflask\app.py", line 338, in init File "flask\config.py", line 174, in from_object File "werkzeug\utils.py", line 563, in import_string File "werkzeug_compat.py", line 147, in reraise File "werkzeug\utils.py", line 558, in import_string werkzeug.utils.ImportStringError: import_string() failed for 'apiflask.settings'. Possible reasons are:

• missing init.py in a package;
• package or module path not included in sys.path;
• duplicated package or module name taking precedence in sys.path;
• missing module, class, function or variable;

Debugged import:

• 'apiflask' found in 'C:\Users\ADMINI~1\AppData\Local\Temp\_MEI324362\apiflask\init.pyc'.
• 'apiflask.settings' not found.

Original exception:

ImportError: module 'apiflask' has no attribute 'settings' [24324] Failed to execute script manage Environment:

• Python version:3.7.4
• Flask version:1.1.1
• APIFlask version:1.1.3

Reading the docs I can't tell if this is currently supported; so apologies if this can already be accomplished.

It would be great if this lib supported iterating over a list of inputs. A single querystring key can have multiple values (if its specified more than once in the URL: e.g. http://localhost/api/myendpoint?ids[]=id_1&ids[]=id_2). But there doesn't seem to be a way to access the individual values of the input list within the API method.

class DeleteQuery(Schema):
    ids = List(String(required=True, data_key='ids[]'))

@app.input(DeleteQuery, location='query')
@app.output({}, status_code=204)
def delete(self, query: DeleteQuery):

    for id in query.ids: #ERROR -> List is not iterable  __iter__ method not defined",
        db.delete(id)

    return "", 204

My application employs multiple blueprints which i would like to generate separate documentation for. I don't want the customers to see the endpoints i use in the internal frontend.

Currently i use workaround with DispatcherMiddleware so i can have multiple app instances, instead of using blueprints. That solution is really cumbersome and creates other issues with debugging, readability, extensions and so on. It would be nice to have option to have multiple endpoints based on Blueprints.