com.aspc.cms.rest.swagger

Interface SwaggerResponses

All Known Implementing Classes:

RestClassNamedV8, RestClassV8, RestSyncNamedV7, RestSyncV7

public interface SwaggerResponses

Describe the responses for your ReST service

Since:

24 Oct 2018

Author:

Lei Gao

Method Summary

Modifier and Type	Method and Description
default JSONObject	createArrayProperty(java.lang.String description, java.lang.Integer minItems, java.lang.Integer maxItems) Check https://swagger.io/docs/specification/data-models/data-types/#array/ for details
default JSONObject	createBooleanProperty(java.lang.String description, boolean example) Check https://swagger.io/docs/specification/data-models/data-types/#boolean/ for details
default JSONObject	createIntegerProperty(java.lang.String description, java.lang.String format, long example, java.lang.Integer minimum, java.lang.Integer maximum, java.lang.Integer mutiple) Check https://swagger.io/docs/specification/data-models/data-types/#numbers/ for details
default JSONObject	createNumberProperty(java.lang.String description, java.lang.String format, java.lang.Object example, java.lang.Double minimum, java.lang.Double maximum, java.lang.Double mutiple) Check https://swagger.io/docs/specification/data-models/data-types/#numbers/ for details
default JSONObject	createObjectProperty(java.lang.String description) Check https://swagger.io/docs/specification/data-models/data-types/#object/ for details
default JSONObject	createStringProperty(java.lang.String description, java.lang.String format, java.lang.String pattern, java.lang.Object example) Check https://swagger.io/docs/specification/data-models/data-types/#string/ for details
void	describeResponse(WebClient client, RestDefinition rd, Method method, JSONObject responses, JSONObject operationObj, java.lang.String restPath, JSONObject definitions) describe the response format.
default JSONObject	getStandardProperty(java.lang.String type, java.lang.String description, java.lang.String format, java.lang.Object example) Check https://swagger.io/docs/specification/data-models/ for details

Method Detail

describeResponse

@Nullable
void describeResponse(@Nonnull
                                WebClient client,
                                @Nonnull
                                RestDefinition rd,
                                @Nonnull
                                Method method,
                                @Nonnull
                                JSONObject responses,
                                @Nonnull
                                JSONObject operationObj,
                                @Nonnull
                                java.lang.String restPath,
                                @Nonnull
                                JSONObject definitions)
                         throws java.lang.Exception

describe the response format. Check https://swagger.io/docs/specification/describing-responses/ for details

sample:

  {
      "200": {
          "description": "successful operation",
          "schema": {
              "$ref": "#/definitions/class_v8_GET"
          }
      },
      "404": {
          "description": "Not found"
      }
  }
 

Parameters:

client - web client

rd - rest definition

method - method

responses - JSONObject that holds the responses

operationObj - the operation json for this service, such as GET /v8/class/Person/{_key} and GET /v8/class/Person are two different operation json

restPath - rest path such as /v8/class/{className}/{_key}

definitions - $ref definition JSONObject

Throws:

java.lang.Exception - a serious problem.

createStringProperty

@Nonnull
default JSONObject createStringProperty(@Nullable
                                                 java.lang.String description,
                                                 @Nullable
                                                 java.lang.String format,
                                                 @Nullable
                                                 java.lang.String pattern,
                                                 @Nullable
                                                 java.lang.Object example)

Check https://swagger.io/docs/specification/data-models/data-types/#string/ for details

create the string item

Parameters:

description - description

format - value format

pattern - Regular expression for the string value

example - example

Returns:

the property json

createNumberProperty

@Nonnull
default JSONObject createNumberProperty(@Nullable
                                                 java.lang.String description,
                                                 @Nullable
                                                 java.lang.String format,
                                                 @Nullable
                                                 java.lang.Object example,
                                                 @Nullable
                                                 java.lang.Double minimum,
                                                 @Nullable
                                                 java.lang.Double maximum,
                                                 @Nullable
                                                 java.lang.Double mutiple)

Check https://swagger.io/docs/specification/data-models/data-types/#numbers/ for details

create the number item

Parameters:

description - description

format - value format

example - example

minimum - minimum value

maximum - maximum value

mutiple - specify a number must be the multiple of this number

Returns:

the property json

createIntegerProperty

@Nonnull
default JSONObject createIntegerProperty(@Nullable
                                                  java.lang.String description,
                                                  @Nullable
                                                  java.lang.String format,
                                                  @Nullable
                                                  long example,
                                                  @Nullable
                                                  java.lang.Integer minimum,
                                                  @Nullable
                                                  java.lang.Integer maximum,
                                                  @Nullable
                                                  java.lang.Integer mutiple)

Check https://swagger.io/docs/specification/data-models/data-types/#numbers/ for details

create the integer item

Parameters:

description - description

format - value format

example - example

minimum - minimum value

maximum - maximum value

mutiple - specify a number must be the multiple of this number

Returns:

the property json

createBooleanProperty

@Nonnull
default JSONObject createBooleanProperty(@Nullable
                                                  java.lang.String description,
                                                  @Nullable
                                                  boolean example)

Check https://swagger.io/docs/specification/data-models/data-types/#boolean/ for details

create the boolean item

Parameters:

description - description

example - example

Returns:

the property json

createArrayProperty

@Nonnull
default JSONObject createArrayProperty(@Nullable
                                                java.lang.String description,
                                                @Nullable
                                                java.lang.Integer minItems,
                                                @Nullable
                                                java.lang.Integer maxItems)

Check https://swagger.io/docs/specification/data-models/data-types/#array/ for details

create the array item

Parameters:

description - description

minItems - array min length

maxItems - array max length

Returns:

the property json

createObjectProperty

@Nonnull
default JSONObject createObjectProperty(@Nullable
                                                 java.lang.String description)

Check https://swagger.io/docs/specification/data-models/data-types/#object/ for details

create the object item

Parameters:

description - description

Returns:

the property json

getStandardProperty

@Nonnull
default JSONObject getStandardProperty(@Nonnull
                                                java.lang.String type,
                                                @Nullable
                                                java.lang.String description,
                                                @Nullable
                                                java.lang.String format,
                                                @Nullable
                                                java.lang.Object example)

Check https://swagger.io/docs/specification/data-models/ for details

create the property json

Parameters:

type - data type

description - description

format - data format

example - example value

Returns:

the property json