com.holonplatform.jaxrs.swagger.v2.SwaggerReader Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016-2018 Axioma srl.
 * 
 * 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 com.holonplatform.jaxrs.swagger.v2;

import java.util.Set;

import io.swagger.models.Swagger;

/**
 * A Swagger API definition reader.
 *
 * @since 5.2.0
 */
public interface SwaggerReader {

	/**
	 * Read given API resource classes and generate the API model.
	 * @param classes The API resource classes to read
	 * @return The API model
	 */
	Swagger read(Set> classes);

}