com.smartbear.swagger4j.impl
Class Utils

java.lang.Object
  extended by com.smartbear.swagger4j.impl.Utils

public class Utils
extends Object

General utilities methods, classes and constants


Nested Class Summary
static class Utils.ConsoleSwaggerStore
          SwaggerStore implementation that writes Swagger definitions to the Console; for debugging
static class Utils.MapSwaggerStore
          SwaggerStore implementation that writes Swagger definitions to a map of fileName to StringWriter
 
Field Summary
static String ALLOW_MULTIPLE
           
static String API_DOCUMENTATION
           
static String API_VERSION
          Constants for the names used in Swagger definitions
static String APIS
           
static String BASE_PATH
           
static String CODE
           
static String CONSUMES
           
static String DATA_TYPE
           
static String DESCRIPTION
           
static String ERROR_RESPONSES
           
static String HTTP_METHOD
           
static String NAME
           
static String NICKNAME
           
static String NOTES
           
static String OPERATIONS
           
static String PARAM_TYPE
           
static String PARAMETERS
           
static String PATH
           
static String PRODUCES
           
static String REASON
           
static String REQUIRED
           
static String RESOURCE_PATH
           
static String RESPONSE_CLASS
           
static String SUMMARY
           
static String SWAGGER_VERSION
           
 
Constructor Summary
Utils()
           
 
Method Summary
static String createFileNameFromPath(String path, Constants.Format format)
          Method for creating a filename from a path - replaces format references and adds the extension.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

API_VERSION

public static final String API_VERSION
Constants for the names used in Swagger definitions

See Also:
Constant Field Values

SWAGGER_VERSION

public static final String SWAGGER_VERSION
See Also:
Constant Field Values

BASE_PATH

public static final String BASE_PATH
See Also:
Constant Field Values

API_DOCUMENTATION

public static final String API_DOCUMENTATION
See Also:
Constant Field Values

PATH

public static final String PATH
See Also:
Constant Field Values

APIS

public static final String APIS
See Also:
Constant Field Values

DESCRIPTION

public static final String DESCRIPTION
See Also:
Constant Field Values

RESOURCE_PATH

public static final String RESOURCE_PATH
See Also:
Constant Field Values

OPERATIONS

public static final String OPERATIONS
See Also:
Constant Field Values

NICKNAME

public static final String NICKNAME
See Also:
Constant Field Values

HTTP_METHOD

public static final String HTTP_METHOD
See Also:
Constant Field Values

SUMMARY

public static final String SUMMARY
See Also:
Constant Field Values

NOTES

public static final String NOTES
See Also:
Constant Field Values

RESPONSE_CLASS

public static final String RESPONSE_CLASS
See Also:
Constant Field Values

PARAMETERS

public static final String PARAMETERS
See Also:
Constant Field Values

NAME

public static final String NAME
See Also:
Constant Field Values

PARAM_TYPE

public static final String PARAM_TYPE
See Also:
Constant Field Values

ALLOW_MULTIPLE

public static final String ALLOW_MULTIPLE
See Also:
Constant Field Values

REQUIRED

public static final String REQUIRED
See Also:
Constant Field Values

DATA_TYPE

public static final String DATA_TYPE
See Also:
Constant Field Values

ERROR_RESPONSES

public static final String ERROR_RESPONSES
See Also:
Constant Field Values

CODE

public static final String CODE
See Also:
Constant Field Values

REASON

public static final String REASON
See Also:
Constant Field Values

PRODUCES

public static final String PRODUCES
See Also:
Constant Field Values

CONSUMES

public static final String CONSUMES
See Also:
Constant Field Values
Constructor Detail

Utils

public Utils()
Method Detail

createFileNameFromPath

public static String createFileNameFromPath(String path,
                                            Constants.Format format)
Method for creating a filename from a path - replaces format references and adds the extension.

Parameters:
path - the path to fix
format - the format to use
Returns:
the created fileName


Copyright © 2013. All Rights Reserved.