@ServerSide @ExtensionPoint public interface WebService extends Definable<WebService.Context>
Plugin
.
public class HelloWs implements WebService { @Override public void define(Context context) { NewController controller = context.createController("api/hello"); controller.setDescription("Web service example"); // create the URL /api/hello/show controller.createAction("show") .setDescription("Entry point") .setHandler(new RequestHandler() { @Override public void handle(Request request, Response response) { // read request parameters and generates response output response.newJsonWriter() .beginObject() .prop("hello", request.mandatoryParam("key")) .endObject() .close(); } }) .createParam("key").setDescription("Example key").setRequired(true); // important to apply changes controller.done(); } }Since version 5.5, a web service can call another web service to get some data. See
Request.localConnector()
provided by RequestHandler.handle(Request, Response)
.Modifier and Type | Interface and Description |
---|---|
static class |
WebService.Action |
static class |
WebService.Context |
static class |
WebService.Controller |
static class |
WebService.NewAction |
static class |
WebService.NewController |
static class |
WebService.NewParam |
static class |
WebService.Param |
static class |
WebService.SelectionMode |
Modifier and Type | Method and Description |
---|---|
void |
define(WebService.Context context)
Executed once at server startup.
|
void define(WebService.Context context)
define
in interface Definable<WebService.Context>
Copyright © 2009–2017 SonarSource. All rights reserved.