io.gravitee.rest.api.service.SwaggerService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gravitee-rest-api-service Show documentation

Gravitee IO Manager Service

There is a newer version: 3.10.0

Show newest version

/**
 * Copyright (C) 2015 The Gravitee team (http://gravitee.io)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.gravitee.rest.api.service;

import io.gravitee.definition.model.DefinitionVersion;
import io.gravitee.rest.api.model.ImportSwaggerDescriptorEntity;
import io.gravitee.rest.api.model.api.SwaggerApiEntity;
import io.gravitee.rest.api.service.impl.swagger.transformer.SwaggerTransformer;
import io.gravitee.rest.api.service.swagger.SwaggerDescriptor;
import java.util.Collection;

/**
 * @author David BRASSELY (david.brassely at graviteesource.com)
 * @author GraviteeSource Team
 */
public interface SwaggerService {
    /**
     * Create an API from a Swagger descriptor. This method does not create an API but
     * extract data from Swagger to prepare an API to then create.
     *
     * @param swaggerDescriptor Swagger descriptor
     * @return The API from the Swagger descriptor
     */
    SwaggerApiEntity createAPI(ImportSwaggerDescriptorEntity swaggerDescriptor);

    /**
     * Create an API from a Swagger descriptor. This method does not create an API but
     * extract data from Swagger to prepare an API to then create.
     *
     * @param swaggerDescriptor Swagger descriptor
     * @param definitionVersion Definition version
     * @return The API from the Swagger descriptor
     */
    SwaggerApiEntity createAPI(ImportSwaggerDescriptorEntity swaggerDescriptor, DefinitionVersion definitionVersion);

    /**
     * This method is used to transform a Swagger descriptor specification using swagger transformers.
     *
     * @param descriptor
     * @param transformers
     * @param 
     * @param 
     */
    > void transform(T descriptor, Collection> transformers);

    /**
     * This method is used to parse a content (can be a plain text content or an URL starting with http|https|file)
     *
     * @param content
     * @return A swagger descriptor
     */
    SwaggerDescriptor parse(String content);

    /**
     * This method is used to parse a content (can be a plain text content or an URL starting with http|https|file)
     *
     * @param content
     * @return A swagger descriptor
     */
    SwaggerDescriptor parse(String content, boolean wsdl);
}