Leveraging the same metadata that the RouteMetadataPlugin uses, generate a route that produces Swagger output to describe the routes. May require some domain annotations to generate details about the domain.

For more information, see: https://github.com/wordnik/swagger-core/wiki

Here is some code that exhibits the error (this is a method from a controller):

public void registerRoutes(final RestExpress restExpress) {
   Objects.requireNonNull(restExpress, "restExpress cannot be null");

   final String collectiveRoute = "/codes.{format}";
   final String singleRoute     = "/codes/{codeId}.{format}";

   restExpress.uri(collectiveRoute, this)
      .action("createCode", HttpMethod.POST)
      .name("createCode");

   restExpress.uri(collectiveRoute, this)
      .action("listCodes", HttpMethod.GET)
      .name("listCodes");

   restExpress.uri(singleRoute, this)
      .action("deleteCode", HttpMethod.DELETE)
      .name("deleteCode");

   restExpress.uri(singleRoute, this)
      .action("getCode", HttpMethod.GET)
      .name("getCode");

   restExpress.uri(singleRoute, this)
      .action("updateCode", HttpMethod.PUT)
      .name("updateCode");
 }

With this code, performing an OPTIONS request against one of the routes returns only two methods: OPTIONS and one other method.

I believe it's because I've created multiple route builders that have the same URI and the following code in CorsHeaderPlugin.register():

methodsByPattern.put(pathPattern, methods);

overwrites the previously inserted value for the pathPattern key.

To make this clearer, I remember seeing the following calls:

methodsByPattern.put("/code", { OPTIONS, GET });
methodsByPattern.put("/code", { OPTIONS, PUT });
methodsByPattern.put("/code", { OPTIONS, DELETE });

The last one wins. Perhaps merging the methods in the map's value would be a good approach.

The workaround I found is to do the following:

public void registerRoutes(final RestExpress restExpress) {
    Objects.requireNonNull(restExpress, "restExpress cannot be null");

    final String collectiveRoute = "/codes.{format}";
    final String singleRoute     = "/codes/{codeId}.{format}";

    restExpress.uri(collectiveRoute, this)
            .action("createCode", HttpMethod.POST)
            .action("listCodes", HttpMethod.GET)
            .name("codes");

    restExpress.uri(singleRoute, this)
            .action("deleteCode", HttpMethod.DELETE)
            .action("updateCode", HttpMethod.PUT)
            .action("getCode", HttpMethod.GET)
            .name("code");
}

Now there is only one RouteBuilder per URI so the methodsByPattern map will never have the same key inserted twice.

If you think my approach of merging methods is the best way to go, I'd be happy to submit a pull request with those changes in it.

Write a plugin to ping Thalassa when the service is alive.

Create a plugin that either uses an incoming Correlation-Id header or assigns one, so subsequent calls can all be correlated in logs.

Can we associate a style file for the generated swagger?. I can only see a plain xml when accessing the swagger api-docs.

I am not sure how much different 1.2 and 2.0 of Swagger is, but can the existing Swagger plugin be upgraded to 2.0 easily, or does this involve a complete overhaul. Trying to see how much work that is.

Include a statsd publisher for the MetricsPlugin.

According to Swagger RESTful API Documentation Specification, (refer : https://github.com/swagger-api/swagger-spec/blob/master/versions/1.2.md) the nickname MUST be alphanumeric and may include underscores ,Whitespace characters are not allowed.

/swagger/src/main/java/com/strategicgains/restexpress/plugin/swagger/domain/ApiOperation.java :

this.nickname = method + (name == null ? "" : " " + name);

My suggestion is to replace the white space with "_".

If you think my suggestion of replacing white space is the best way to go, I'd be happy to submit a pull request with those changes in it.

Annotation dependency, extcos, causes tests to hang. Hasn't be updated since 2012 and doesn't appear to run correctly on Java 1.8

Removed Annotation plugin from PluginExpress release 0.3.1