Examples of org.sonar.api.server.ws.WebService

org.sonar.api.server.ws.WebService

te the URL /api/hello/show controller.createAction("show") .setDescription("Entry point") .setHandler(new RequestHandler() { {@literal @}Override public void handle(Request request, Response response) { // read request parameters and generates response output response.newJsonWriter() .prop("hello", request.mandatoryParam("key")) .close(); } }) .createParam("key").setDescription("Example key").setRequired(true); // important to apply changes controller.done(); } }

How to test

 public class HelloWsTest { WebService ws = new HelloWs(); {@literal @}Test public void should_define_ws() throws Exception { // WsTester is available in the Maven artifact org.codehaus.sonar:sonar-testing-harness WsTester tester = new WsTester(ws); WebService.Controller controller = tester.controller("api/hello"); assertThat(controller).isNotNull(); assertThat(controller.path()).isEqualTo("api/hello"); assertThat(controller.description()).isNotEmpty(); assertThat(controller.actions()).hasSize(1); WebService.Action show = controller.action("show"); assertThat(show).isNotNull(); assertThat(show.key()).isEqualTo("show"); assertThat(index.handler()).isNotNull(); } }

@since 4.2

  }


  @Test
  public void defineFieldsParam() throws Exception {
    WebService.Context context = new WebService.Context();
    new WebService() {
      @Override
      public void define(Context context) {
        NewController newController = context.createController("api/foo");
        NewAction action = newController.createAction("search").setHandler(mock(RequestHandler.class));
        SearchOptions.defineFieldsParam(action, Lists.newArrayList("name", "lang", "severity"));

  }


  @Test
  public void definePageParams() throws Exception {
    WebService.Context context = new WebService.Context();
    new WebService() {
      @Override
      public void define(Context context) {
        NewController newController = context.createController("api/foo");
        NewAction action = newController.createAction("search").setHandler(mock(RequestHandler.class));
        SearchOptions.definePageParams(action);

Examples of org.sonar.api.server.ws.WebService

How to test

Related Classes of org.sonar.api.server.ws.WebService