Page History
...
Writing CS API Request class
- Pick up the *Cmd abstract class to extend by the request.
CUD (create/update/delete commands):
R (read-list) commands:
Important - starting 2.x, new CUD API command can no longer extend BaseCmd class; they should come as Async command, and extend either BaseAsyncCmd, or BaseAsyncCreateCmd.
When to extend BaseAsyncCmd vs BaseAsyncCreateCmd? Use BaseAsyncCreate for the commands creating a new CS entry. For UD commands extend BaseAsyncCmd.
2. Command class that you add, should end with *Cmd, and annotated with @ApiCommand. Read more about @ parameters in Annotations use in the API ref.
3. Define all request parameters. Annotate them all with @Parameter.
4. Implement execute() for RUD commands, and execute()/create() for C commands.TBD
Writing CS API Response class
TBD
API placement and registration
...
Overview
Content Tools
Apps