com.mulesoft.connectivity.rest.sdk.internal.webapi.model

Class APIModel

java.lang.Object

com.mulesoft.connectivity.rest.sdk.internal.webapi.model.APIModel

Direct Known Subclasses:

AMFAPIModel

public abstract class APIModel
extends Object

Constructor Summary

Constructors

Constructor and Description
APIModel(String apiName, String description, String baseUri, String apiVersion, List<APIOperationModel> operations, List<String> protocols)

Method Summary

Modifier and Type	Method and Description
Optional<APIOperationModel>	findOperation(String operationId) Finds an operation by operationId.
Optional<APIOperationModel>	findOperation(String path, String method) Finds an operation by method and path.
String	getApiName()
String	getApiVersion()
String	getBaseUri()
String	getDescription()
abstract APILocation	getLocation() Retrieves the location in the API Spec this element was parsed from.
List<APIOperationModel>	getOperationsModel()
List<String>	getProtocols()

Methods inherited from class java.lang.Object

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

Constructor Detail

APIModel

public APIModel(String apiName,
                String description,
                String baseUri,
                String apiVersion,
                List<APIOperationModel> operations,
                List<String> protocols)

Method Detail

getApiName

public String getApiName()

getDescription

public String getDescription()

getProtocols

public List<String> getProtocols()

getBaseUri

public String getBaseUri()

getApiVersion

public String getApiVersion()

getOperationsModel

public List<APIOperationModel> getOperationsModel()

getLocation

public abstract APILocation getLocation()

Retrieves the location in the API Spec this element was parsed from.

findOperation

public Optional<APIOperationModel> findOperation(String operationId)

Finds an operation by operationId.

Parameters:

operationId - the operationId

Returns:

an APIOperationModel with the given operationId

findOperation

public Optional<APIOperationModel> findOperation(String path,
                                                 String method)

Finds an operation by method and path.

Parameters:

path - an endpoint path

method - an HTTP method

Returns:

an APIOperationModel with the given method and path