Criar um esquema de eventos no Amazon EventBridge - Amazon EventBridge

Criar um esquema de eventos no Amazon EventBridge

São criados esquemas usando arquivos JSON com a especificação OpenAPI ou a especificação JSONSchema Draft4. Também é possível criar ou carregar seus próprios esquemas no EventBridge usando um modelo ou gerando um esquema com base no JSON de um evento. Também é possível inferir o esquema de eventos em um barramento de eventos. Para criar um esquema usando a API do registro de esquemas do EventBridge, use a ação de API CreateSchema.

Ao escolher entre os formatos OpenAPI 3 e JSONSchema Draft4, considere as seguintes diferenças:

  • O formato JSONSchema suporta palavras-chave adicionais que não são compatíveis com a OpenAPI, como $schema, additionalItems.

  • Há pequenas diferenças na forma como as palavras-chave são tratadas, como type e format.

  • A OpenAPI não é compatível com hiperlinks JSONSchema Hyper-Schema em documentos JSON.

  • As ferramentas para OpenAPI tendem a se concentrar no tempo de construção, enquanto as ferramentas para JSONSchema tendem a se concentrar em operações em tempo de execução, como ferramentas de cliente para validação de esquemas.

É recomendado usar o formato JSONSchema para implementar a validação do lado do cliente para que os eventos enviados ao EventBridge estejam em conformidade com o esquema. É possível usar o JSONSchema para definir um contrato para documentos JSON válidos e usar um validador de esquema JSON antes de enviar os eventos associados.

Depois de ter um novo esquema, é possível baixar vinculações de código para ajudar a criar aplicações para eventos com esse esquema.