如何在openapi3文档中保持Schema的顺序

OliverQing · 2024 年12 月 17 日 11:50

Hello大家，我是Oliver。
如题，我想知道如何让 @apiflask.input中的传入的Schema能够在openapi文档保持原有的序列？

在用户尝试从openapi文档的tryout登录时就会出现，password在上面，username在下面，如果第一次使用文档，又不仔细看，会出现错误。还有就是字段的排序，可以从上至下的按照字段的重要性排序。虽然但是，这可能是我对文档的催毛求疵，但还是想看看有没有解决方法。

我没找到什么有效的办法去解决这个问题，我看到StackOverflow上面有关于flask方面的设置和设置 meta，但是不起效

class login_form(Schema):
  username: string
  password: string

OliverQing · 2024 年12 月 18 日 02:22

我发现可能需要写一个example。input的真正意义是检查…

OliverQing · 2024 年12 月 18 日 03:39

example也没能解决这问题……

OliverQing · 2024 年12 月 18 日 05:47

最新，跟栈看到原来是jsonify导致，查了下flask的change log，2.3用json provider来代替原来的配置。。

ok……继续搞下

OliverQing · 2024 年12 月 18 日 07:17

搞定了。就是配置jsonprovider

对于这个我不知道大家是怎么看的。

我在题目中的需求存在的情况下，感觉是可以不用jsonify这个方法返回，不过我还对这个json provider还停留在 “看过” “用过”的认知，还不知道他可不可以在某些情况选择某些情况不选择

uncle-lv · 2024 年12 月 18 日 11:25

设置这个属性就可以了

app.json.sort_keys = False

sort_keys从Flask 2.2之后，是DefaultJSONProvider的一个属性了

pallets/flask/blob/6b054f8f3876ff4c31580b014d344c4cf491059d/src/flask/json/provider.py#L150


      
          not know how to serialize. It should return a valid JSON type or
          raise a ``TypeError``.
          """
          
          ensure_ascii = True
          """Replace non-ASCII characters with escape sequences. This may be
          more compatible with some clients, but can be disabled for better
          performance and size.
          """
          
          sort_keys = True
          """Sort the keys in any serialized dicts. This may be useful for
          some caching situations, but can be disabled for better performance.
          When enabled, keys must all be strings, they are not converted
          before sorting.
          """
          
          compact: bool | None = None
          """If ``True``, or ``None`` out of debug mode, the :meth:`response`
          output will not add indentation, newlines, or spaces. If ``False``,
          or ``None`` in debug mode, it will use a non-compact representation.

github.com/pallets/flask

add JSON provider interface

pallets:main ← pallets:json-provider

opened 03:11PM - 13 Jul 22 UTC

davidism

+664 -284

This adds the ability to fully customize the JSON implementation used by a Flask… application. Using a different JSON implementation can greatly speed up API applications that need to work with JSON in most requests. `app.json` is an instance of `Flask.json_provider_class`. `flask.json.provider.JSONProvider` is the base class that defines `dumps`, `dump`, `loads`, `load`, and `response` methods, of which only `dumps` and `loads` need to be implemented. For example, here's a provider for [orjson](https://github.com/ijl/orjson): ```python from flask.json.provider import JSONProvider import orjson class OrJSONProvider(JSONProvider): def dumps(self, obj, *, option=None, **kwargs): if option is None: option = orjson.OPT_APPEND_NEWLINE | orjson.OPT_NAIVE_UTC return orjson.dumps(obj, option=option).decode() def loads(self, s, **kwargs): return orjson.loads(s) # assign to an app instance app.json = OrJSONProvider(app) # or assign in a subclass class MyFlask(Flask): json_provider_class = OrJSONProvider app = MyFlask(__name__) ``` The methods in `flask.json` call the methods on `app.json` if an app context is active, or fall back to the `json` library. `jsonify` calls `app.json.response`. The `|tojson` filter uses `app.json.dumps`. `Request.json` uses `app.json.loads` and `Response.json` uses `app.json.dumps`; the test client uses these as well. Customizing `json_encoder` or `json_decoder` on an app or blueprint, and the `JSONEncoder` and `JSONDecoder` classes, are deprecated. This was not an effective way to use other libraries. Customizing per blueprint was requested by an API extension that is no longer maintained and didn't appear to use the feature. It's not clear how it would work with the new provider interface and added overhead to every request. Instead, API frameworks should be using a dedicated object serialization library, then taking advantage of a fast JSON serializer at the application level. The `DefaultJSONProvider` is the existing implementation using the built-in `json` library. The `app.config` keys `JSON_AS_ASCII`, `JSON_SORT_KEYS`, `JSONIFY_MIMETYPE`, and `JSONIFY_PRETTYPRINT_REGULAR` are deprecated and have moved to attributes on the default provider. Other providers are not required to support these options.