3 ms·
> pick a standard (openapi? jsonschema? something else?) This is a false dichotomy, as OpenAPI and JSON Schema are complementary: as of version 3.1, OpenAPI us
by BerislavLopac 3y ago
> pick a standard (openapi? jsonschema? something else?)
This is a false dichotomy, as OpenAPI and JSON Schema are complementary: as of version 3.1, OpenAPI use JSON Schema to describe request and response payload content (prior to that version it was almost compatible).
They describe different things: OpenAPI describes the request-response API model, while JSON Schema can be used to specify contents of any JSON-encoded data -- for example in streaming messages or document databases.
There is also AsyncAPI, which is designed to document and specify the event-based API, for example in a system using Apache Kafka or a similar queue to communicate.