com.eviware.soapui.impl.actions

Interface SilentApiImporter

All Known Implementing Classes:

SilentGraphQLApiImporterFactory.GraphQLSilentImporter, SilentSwaggerApiImporterFactory.SwaggerApiImporter, SilentWadlApiImporterFactory.WadlApiImporter, SilentWsdlApiImporterFactory.SilentWsdlApiImporter

public interface SilentApiImporter

Defines a class that can import APIs without user interactions.

Method Summary

Modifier and Type	Method and Description
boolean	acceptsURL(URL url) Called to check whether the URL indicates that this import method can handle its content.
Collection<com.eviware.soapui.model.iface.Interface>	importApi(URL definitionUrl, com.eviware.soapui.impl.wsdl.WsdlProject project) Creates an API (Interface) in the provided project from the definition found at the URL.

Method Detail

acceptsURL

boolean acceptsURL(URL url)

Called to check whether the URL indicates that this import method can handle its content. NOTE: An import method will not be able to determine from just the URL if the content is acceptable, so ReadyAPI may still try to parse it.

Parameters:

url - The URL pointing to an API definition

Returns:

true if and only if the URL clearly indicates that it points to a definition that this import method can parse

Throws:

NullPointerException - if URL is null

importApi

Collection<com.eviware.soapui.model.iface.Interface> importApi(URL definitionUrl,
                                                               com.eviware.soapui.impl.wsdl.WsdlProject project)
                                                        throws UnsupportedDefinitionException

Creates an API (Interface) in the provided project from the definition found at the URL.

Parameters:

definitionUrl - a URL pointing to an API definition (such as WSDL or Swagger)

project - the project that the API should be added to

Returns:

a collection of imported APIs - should return an empty collection if no APIs were imported

Throws:

UnsupportedDefinitionException - if this import method cannot parse the definition