Skip to main content

Add D2-REST controller support to a plugin project

If a D2SV plugin intends to deploy new D2-REST endpoints in addition to the factory endpoints, then this option of the workspace assistant comes in handy.

Upon successful execution, this option, can add a boilerplate REST controller definition to the plugin such that the controller handles HTTP GET(Retrieve), POST(Create), DELETE(Delete) operation on the specified endpoint resource matching part of the CRUD style transaction.

The complete URL path of the endpoint created is represented as -

/D2-Smartview/repositories/<repo_name>/<group_name>/<endpoint_name>
caution

Use this option when at least one plugin project exists in the workspace.

Associated questions and their meanings -

  • Select plugin to add REST support

    Specify the plugin project where to add boilerplate for this controller

  • Group name of controller

    Group name for the service that this REST controller implements. Used as <group_name> part of the URL format mentioned above. Usually same group name is used across multiple services if they all happen to be correlated.

  • Endpoint name of controller

    A meaningful name that should uniquely identify this endpoint in the group of correlated services. This name is used as <endpoint_name> part of the URL format mentioned above.

  • Service name to use against the controller

    Name of the service that this endpoint represents. This name is used to form the name of Java classes and interfaces which are finally going to implement the service.