Package com.github.chhorz.openapi.common.domain

Class Reference

java.lang.Object

com.github.chhorz.openapi.common.domain.Reference

public class Reference
extends Object

https://spec.openapis.org/oas/v3.1.0#reference-object

Author:

chhorz

Constructor Summary

Constructors

Constructor	Description
Reference()
Reference(String $ref)

Method Summary

Modifier and Type	Method	Description
static Reference	forRequestBody(String referenceString)	Creates a new reference for a request body.
static Reference	forSchema(String referenceString)	Creates a new schema reference.
String	get$ref()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Reference

public Reference()

Reference

public Reference(String $ref)

Method Details

forSchema

public static Reference forSchema(String referenceString)

Creates a new schema reference.

Parameters:

referenceString - the schema to create a reference for

Returns:

the OpenAPI Reference

forRequestBody

public static Reference forRequestBody(String referenceString)

Creates a new reference for a request body.

Parameters:

referenceString - the response body to create a reference for

Returns:

the OpenAPI Reference

get$ref

public String get$ref()

toString

public String toString()

Overrides:

toString in class Object