org.wso2.carbon.apimgt.importexport

Class APIService

java.lang.Object

org.wso2.carbon.apimgt.importexport.APIService

@Path(value="/")
public class APIService
extends Object

This class provides JAX-RS services for exporting and importing APIs. These services provides functionality for exporting and importing single API at a time.

Constructor Summary

Constructors

Constructor and Description
APIService()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	exportAPI(String name, String version, String providerName, javax.ws.rs.core.HttpHeaders httpHeaders) This service exports an API from API Manager for a given API ID Meta information, API icon, documentation, WSDL and sequences are exported This service generates a zipped archive which contains all the above mentioned resources for a given API
javax.ws.rs.core.Response	importAPI(InputStream uploadedInputStream, String defaultProviderStatus, javax.ws.rs.core.HttpHeaders httpHeaders) This is the service which is used to import an API.

Methods inherited from class java.lang.Object

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

Constructor Detail

APIService

public APIService()

Method Detail

exportAPI

@GET
 @Path(value="/export-api")
 @Produces(value="application/zip")
public javax.ws.rs.core.Response exportAPI(@QueryParam(value="name")
                                                                                                                String name,
                                                                                                                @QueryParam(value="version")
                                                                                                                String version,
                                                                                                                @QueryParam(value="provider")
                                                                                                                String providerName,
                                                                                                                @Context
                                                                                                                javax.ws.rs.core.HttpHeaders httpHeaders)

This service exports an API from API Manager for a given API ID Meta information, API icon, documentation, WSDL and sequences are exported This service generates a zipped archive which contains all the above mentioned resources for a given API

Parameters:

name - Name of the API that needs to be exported

version - Version of the API that needs to be exported

providerName - Provider name of the API that needs to be exported

Returns:

Zipped API as the response to the service call

importAPI

@POST
 @Path(value="/import-api")
 @Consumes(value="multipart/form-data")
 @Produces(value="application/json")
public javax.ws.rs.core.Response importAPI(InputStream uploadedInputStream,
                                                                                                                                                          @QueryParam(value="preserveProvider")
                                                                                                                                                          String defaultProviderStatus,
                                                                                                                                                          @Context
                                                                                                                                                          javax.ws.rs.core.HttpHeaders httpHeaders)

This is the service which is used to import an API. All relevant API data will be included upon the creation of the API. Depending on the choice of the user, provider of the imported API will be preserved or modified.

Parameters:

uploadedInputStream - uploadedInputStream input stream from the REST request

defaultProviderStatus - user choice to keep or replace the API provider

httpHeaders - HTTP headers for the authentication mechanism

Returns:

response for the API process