com.aspc.cms.rest.swagger

Class SwaggerUtil

java.lang.Object

com.aspc.cms.rest.swagger.SwaggerUtil

public class SwaggerUtil
extends java.lang.Object

Since:

02 Nov 2018

Author:

Lei Gao

Constructor Summary

Constructors

Constructor and Description
SwaggerUtil()

Method Summary

Modifier and Type	Method and Description
static JSONObject	addStandardResponse(JSONObject responses, Status status) add standard response to the given responses json and status
static JSONObject	addStandardResponse(JSONObject responses, Status status, java.lang.String description) add standard response to the given responses json and status
static java.lang.String	encodeRefName(java.lang.String refName) replace ~ and / to _ in ref name

Methods inherited from class java.lang.Object

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

Constructor Detail

SwaggerUtil

public SwaggerUtil()

Method Detail

addStandardResponse

public static JSONObject addStandardResponse(@Nonnull
                                             JSONObject responses,
                                             @Nonnull
                                             Status status)

add standard response to the given responses json and status

Parameters:

responses -

status -

Returns:

the responses JSONObject added to the responses

addStandardResponse

public static JSONObject addStandardResponse(@Nonnull
                                             JSONObject responses,
                                             @Nonnull
                                             Status status,
                                             @Nonnull
                                             java.lang.String description)

add standard response to the given responses json and status

Parameters:

responses -

status -

description - status description

Returns:

the responses JSONObject added to the responses

encodeRefName

public static java.lang.String encodeRefName(@Nonnull
                                             java.lang.String refName)

replace ~ and / to _ in ref name

Parameters:

refName -

Returns:

the value