Package io.github.primelib.webmethodsapigateway4j.model

Klasse RestAPI

java.lang.Object

io.github.primelib.webmethodsapigateway4j.model.API

io.github.primelib.webmethodsapigateway4j.model.RestAPI

@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator")
public class RestAPI
extends API

RestAPI

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected List<String>	apiTags	A list of API level tags for API documentation control.
protected Components	components
protected List<ExternalDocs>	externalDocs	Additional external documentation
protected Info	info
protected Map<String,Path>	paths	The available paths and operations for the API
protected List<Server>	servers	An array of Server Objects, which provide connectivity information to a target server
protected String	serviceRegistryDisplayName	The name of the API in service registry when the API is published to a service registry.
protected List<Tag>	tags	A list of tags with additional metadata
protected Map<String,Object>	vendorExtensions

Von Klasse geerbte Felder io.github.primelib.webmethodsapigateway4j.model.API

description, title, type, uri, version

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
protected	RestAPI()
	RestAPI(Consumer<RestAPI> spec)	Constructs a validated implementation of RestAPI.
	RestAPI(List<String> apiTags, Components components, List<ExternalDocs> externalDocs, Info info, Map<String,Path> paths, List<Server> servers, String serviceRegistryDisplayName, List<Tag> tags, Map<String,Object> vendorExtensions)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
List<String>	apiTags()	A list of API level tags for API documentation control.
RestAPI	apiTags(List<String> apiTags)	A list of API level tags for API documentation control.
protected boolean	canEqual(Object other)
Components	components()
RestAPI	components(Components components)
boolean	equals(Object o)
List<ExternalDocs>	externalDocs()	Additional external documentation
RestAPI	externalDocs(List<ExternalDocs> externalDocs)	Additional external documentation
int	hashCode()
Info	info()
RestAPI	info(Info info)
Map<String,Path>	paths()	The available paths and operations for the API
RestAPI	paths(Map<String,Path> paths)	The available paths and operations for the API
List<Server>	servers()	An array of Server Objects, which provide connectivity information to a target server
RestAPI	servers(List<Server> servers)	An array of Server Objects, which provide connectivity information to a target server
String	serviceRegistryDisplayName()	The name of the API in service registry when the API is published to a service registry.
RestAPI	serviceRegistryDisplayName(String serviceRegistryDisplayName)	The name of the API in service registry when the API is published to a service registry.
List<Tag>	tags()	A list of tags with additional metadata
RestAPI	tags(List<Tag> tags)	A list of tags with additional metadata
String	toString()
Map<String,Object>	vendorExtensions()
RestAPI	vendorExtensions(Map<String,Object> vendorExtensions)

Von Klasse geerbte Methoden io.github.primelib.webmethodsapigateway4j.model.API

description, description, title, title, type, type, uri, uri, version, version

Von Klasse geerbte Methoden java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Felddetails

apiTags

protected List<String> apiTags

A list of API level tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier

components

protected Components components

externalDocs

protected List<ExternalDocs> externalDocs

Additional external documentation

info

protected Info info

paths

protected Map<String,Path> paths

The available paths and operations for the API

servers

protected List<Server> servers

An array of Server Objects, which provide connectivity information to a target server

serviceRegistryDisplayName

protected String serviceRegistryDisplayName

The name of the API in service registry when the API is published to a service registry.

tags

protected List<Tag> tags

A list of tags with additional metadata

vendorExtensions

protected Map<String,Object> vendorExtensions

Konstruktordetails

RestAPI

@Internal
public RestAPI(Consumer<RestAPI> spec)

Constructs a validated implementation of RestAPI.

Parameter:

spec - the specification to process

RestAPI

public RestAPI(List<String> apiTags,
 Components components,
 List<ExternalDocs> externalDocs,
 Info info,
 Map<String,Path> paths,
 List<Server> servers,
 String serviceRegistryDisplayName,
 List<Tag> tags,
 Map<String,Object> vendorExtensions)

RestAPI

protected RestAPI()

Methodendetails

apiTags

public List<String> apiTags()

A list of API level tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier

Setzt außer Kraft:

apiTags in Klasse API

components

public Components components()

externalDocs

public List<ExternalDocs> externalDocs()

Additional external documentation

info

public Info info()

paths

public Map<String,Path> paths()

The available paths and operations for the API

servers

public List<Server> servers()

An array of Server Objects, which provide connectivity information to a target server

serviceRegistryDisplayName

public String serviceRegistryDisplayName()

The name of the API in service registry when the API is published to a service registry.

Setzt außer Kraft:

serviceRegistryDisplayName in Klasse API

tags

public List<Tag> tags()

A list of tags with additional metadata

Setzt außer Kraft:

tags in Klasse API

vendorExtensions

public Map<String,Object> vendorExtensions()

apiTags

public RestAPI apiTags(List<String> apiTags)

A list of API level tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier

Setzt außer Kraft:

apiTags in Klasse API

Gibt zurück:

this.

components

public RestAPI components(Components components)

Gibt zurück:

this.

externalDocs

public RestAPI externalDocs(List<ExternalDocs> externalDocs)

Additional external documentation

Gibt zurück:

this.

info

public RestAPI info(Info info)

Gibt zurück:

this.

paths

public RestAPI paths(Map<String,Path> paths)

The available paths and operations for the API

Gibt zurück:

this.

servers

public RestAPI servers(List<Server> servers)

An array of Server Objects, which provide connectivity information to a target server

Gibt zurück:

this.

serviceRegistryDisplayName

public RestAPI serviceRegistryDisplayName(String serviceRegistryDisplayName)

The name of the API in service registry when the API is published to a service registry.

Setzt außer Kraft:

serviceRegistryDisplayName in Klasse API

Gibt zurück:

this.

tags

public RestAPI tags(List<Tag> tags)

A list of tags with additional metadata

Setzt außer Kraft:

tags in Klasse API

Gibt zurück:

this.

vendorExtensions

public RestAPI vendorExtensions(Map<String,Object> vendorExtensions)

Gibt zurück:

this.

toString

public String toString()

Setzt außer Kraft:

toString in Klasse API

equals

public boolean equals(Object o)

Setzt außer Kraft:

equals in Klasse API

canEqual

protected boolean canEqual(Object other)

Setzt außer Kraft:

canEqual in Klasse API

hashCode

public int hashCode()

Setzt außer Kraft:

hashCode in Klasse API