如何在 OpenAPI 中定义 json-lines 响应？

Question

有没有办法用 OpenAPI 来描述 json-lines？

除了似乎还没有 MIME 类型之外，我想知道是否可以描述这样的响应。

理论上我的响应可能是一组对象，但我收到了一个问题：是否可以以 json-lines 的形式传递，意思是：只是对象，每行一个。

由于我使用 OpenAPI 来描述我的 API，我很困惑如何描述这个响应。我可以简单地将响应定义为“字符串”类型，但这对于我的 API 规范的读者来说并不是很有帮助。

Answer 1

我认为没有明确定义的方法可以做到这一点，因为没有官方的 MIME 类型的 json-lines，也没有明确的方法来记录 OpenAPI 中由行分隔的记录列表组成的模式。

当我记录这样的 API 时，我使用

application/octet-stream

或

application/x-ndjson

作为 MIME 类型，然后在 API 描述中指定架构定义适用于请求/响应中的每条记录。

Answer 2

jsonl 通常只是 JSON 解析器和序列化器限制的解决方法。如果您有流解析器，例如 https://www.npmjs.com/package/stream-json，则可以使用标准 JSON 数组。