SwaggerStore.java

/**
 * Copyright 2013 SmartBear Software, Inc.
 * <p>
 * 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 com.smartbear.swagger4j;

import java.io.IOException;
import java.io.Writer;

/**
 * Simple interface of abstracting the target location of a created Swagger definition, so Swagger objects
 * can be written to non file-based stores (databases, etc)
 */

public interface SwaggerStore {

    /**
     * Create a resource with the specified path
     *
     * @param path the path of the resource to create
     * @return a Writer to which the resource can be written
     * @throws IOException
     */

    public Writer createResource(String path) throws IOException;
}