com.aspc.cms.rest.swagger

Interface SwaggerRefDefinition

public interface SwaggerRefDefinition

Define the $ref for your ReST service

Since:

24 Oct 2018

Author:

Lei Gao

Method Summary

Modifier and Type	Method and Description
void	defineRef(WebClient client, RestDefinition rd, JSONObject definition) define the $ref.

Method Detail

defineRef

void defineRef(@Nonnull
               WebClient client,
               @Nonnull
               RestDefinition rd,
               @Nonnull
               JSONObject definition)
        throws java.lang.Exception

define the $ref. Check https://swagger.io/docs/specification/using-ref/ for details

sample:

  {
      "class_v8_GET_single": {
          "type": "object",
          "required": [
              "_global_key",
              "_href",
              "id"
          ],
          "properties": {
              "_global_key": {
                  "type": "string"
              },
              "_href": {
                  "type": "string"
              },
              "id": {
                  "type": "integer",
                  "format": "int32"
              },
              "status": {
                  "type": "string",
                  "description": "Status",
                  "enum": [
                      "Entered",
                      "Started",
                      "Finished",
                  ]
              },
              "lastJob": {
                  "$ref": "#/definitions/Job"
              },
              "tags": {
                  "type": "array",
                  "items": {
                      "$ref": "#/definitions/Tag"
                  }
              },
          }
      },
      404: {
          description: "Not found"
      }
  }
 

Parameters:

client - web client

rd - rest definition

definition - JSONObject holds the $ref

Throws:

java.lang.Exception - a serious problem.