OpenApi 3.0: a reference to the existing class

Question

I want to use a class from a library as a type of a property. Say it is foo.lib.Foo. What is the right way to properly define it as a type of the property?

SomeDto:
  type: object
  properties:
     foo:
        $ref: `foo.lib.Foo`??? 

Answer 1

This can be done through defining a type mapping and referring the type explicitly.

1. Define a type mapping in the plugin configuration

    <configuration>
         ...
         <importMappings>
             <importMapping>Foo=foo.lib.Foo</importMapping>
         </importMappings>
         ...
    </configuration>

2. Refer the type:

SomeDto:
  type: object
  properties:
     foo:
        $ref: '#/components/schema/Foo' 

3. Include the dependency of the library in the classpath (the dependencies section).

UPDATE in case it still doesn't work, try to refer your class as follows:

SomeDto:
  type: object
  properties:
     foo:
        $ref: 'Foo'