#ref: to external specifications in a file or an uri

[akochse]

Hi
I am a fresh user of asyncapi but an old messaging fan.
While writing the first few asyncapi specs for my students I wondered if general schema definitions could also be referenced among more than one specitifaction.
The situation is, that I specify the interface specs for various (micro-)services in similar domains. Certain DTOs could be used in more than one message across more than one service.
The expecation would be that there would be something like:
#ref: 'https:/exmample.com/api/mydomain/schemas/order-response-dto'
I went through the specs of #ref-Arguments. (JSON Reference) but it seems not to be accepted by the AsyncStudio.
Any hints or discussions already held.
Thanks
Andi

[derberg]

@akochse thanks for reaching out. So yes, there is an option to share schemas, you do it with $ref

Here you have an example on how referencing inside the same AsyncAPI document works, but $ref works with URLs too. Actually it is getting pretty common (at least for Kafka ecosystem) that people put schemas inside so cold Schema Registries, and share and version schemas through the registry that is like a schema store (Apicurio Registry is one of implementations of the concept)

Does that help?

[derberg]

Ah, and yes reference to file also is possible, but since Studio is web app, it do not support access to local file system (at least for now)

[akochse]

Thanks a lot for your answer and reference (sorry my late respone) that helps.

[quetzalliwrites]

Thank you @derberg!