Virtual Track sessions will be available on-demand on the
OpenAPI Initiative YouTube channel at 9:00 AM PT on Monday, September 19. View the sessions
here and watch your favorites before joining the Speaker Q&A session on the OpenAPI Initiative Slack workspace at 12:00 PM PT.
Watch the SessionsJoin the OAI Slack WorkspaceOnce you’ve joined Slack, join the
#asc2022_virtual-track channel. A thread will be created for each talk where speakers and attendees can discuss the content. Please note that not all virtual speakers are able to participate in the Q&A session, but please keep the conversation going with fellow viewers!
---------------------------------------------------------------------------------------------------------------------------------------------------
JSON Schema plays a crucial role of defining message payloads in the OpenAPI and AsyncAPI specifications. The JSON Schema specification is a very mature and robust standard for describing how to validate a JSON payload. It is a sharp sword, precise and well-honed to that job.
But the other edge of that sword may also draw blood when applied as a data modeling language. What works beautifully for validation can cause code generation nightmares for marshaling request and response JSON into native programming language constructs such as interfaces, types, classes, and prototypes. This is the result of using the JSON Schema standard for two different purposes in the API specifications – killing two birds with one sword, to butcher a metaphor or two.
In this talk, I'll discuss techniques for using a subset of JSON Schema effectively in API design. Next, we'll provide guidance on protecting yourself and your API from the perils of the more intricate aspects of JSON Schema that make consuming the API and coding API services and clients so... perilous. Finally, you will learn of efforts to define JSON Schema vocabularies and API specification changes to enable "better" tool-generated client and service code.
