Skip to content

Latest commit

 

History

History
145 lines (102 loc) · 5 KB

README.md

File metadata and controls

145 lines (102 loc) · 5 KB
Raw

KumuluzEE Swagger

Build Status

KumuluzEE Swagger project provides powerful tools to incorporate and visualize the Swagger (OpenAPI 2.0) specification to your microservice.

KumuluzEE Swagger (OpenAPI 2.0) project provides support for documenting APIs using Swagger/OpenAPI v2 compliant annotations. Project automatically hooks-up servlet that exposes API specification on endpoint /api-specs/<jax-rs application-base-path>/swagger.[json|yaml]. Project also provides SwaggerUI which is added to your project to visualize API documentation and allow API consumers to interact with API endpoints.

More details: Swagger Specification.

Usage

You can enable the KumuluzEE Swagger support by adding the following dependency:

<dependency>
    <groupId>com.kumuluz.ee.swagger</groupId>
    <artifactId>kumuluzee-swagger</artifactId>
    <version>${kumuluzee-swagger.version}</version>
</dependency>

Swagger configuration

When kumuluzee-swagger dependency is included in the project, you can start documenting your REST API using Swagger-Core Annotations.

Documenting application class

@SwaggerDefinition(info = @Info(title = "CustomersAPI", version = "v1.0.0"), host = "localhost:8080")
@ApplicationPath("v1")
public class CustomerApplication extends Application { ... }

Documenting resource class and operations

@Path("customers")
@Api
@Produces(MediaType.APPLICATION_JSON)
public class CustomerResource {

    @GET
    @ApiOperation(value = "Get customers list", tags = {"customers"}, notes = "Returns a list of customers.",
            authorizations = {
                    @Authorization(value = "application")})
    @ApiResponses(value = {
            @ApiResponse(
                    message = "List of customers",
                    code = 200,
                    response = Customer.class,
                    responseContainer = "List")
    })
    public Response getCustomers() {

        List<Customer> customers = new ArrayList<>();
        Customer c = new Customer("1", "John", "Doe");

        customers.add(c);

        return Response.status(Response.Status.OK).entity(customers).build();
    }
}

Accessing API specification

Build and run project using:

mvn clean package
java -jar target/${project.build.finalName}.jar

After startup API specification will be available at:

http://<-hostname-:<-port->/api-specs/<-application-base-path->/swagger.[json,yaml]

Example:

http://localhost:8080/api-specs/v1/swagger.json

Serving Swagger specification can be disabled by setting property kumuluzee.swagger.spec.enabled to false. By default serving API spec is enabled.

Adding Swagger-UI

To serve API specification in visual form and to allow API consumers to interact with API resources you can add Swagger-UI by including dependency kumuluzee-swagger-ui:

<dependency>
    <groupId>com.kumuluz.ee.swagger</groupId>
    <artifactId>kumuluzee-swagger-ui</artifactId>
    <version>${kumuluzee-swagger.version}</version>
</dependency>

Dependency will include SwaggerUI artifacts, in case you want to temporarily disable UI you can set configuration property kumuluzee.swagger.ui.enabled to false:

kumuluzee:
  swagger:
    ui:
      enabled: false

After the startup Swagger-UI is available at: http://localhost:8080/api-specs/ui.

If you want to completely disable swagger extension you can set the following property kumuluzee.swagger.enabled to false:

kumuluzee:
  swagger:
    enabled: false

Changing hostname and base path

Hostname and base path can be overridden in swagger.[json,yaml] by setting config parameter kumuluzee.swagger.base-url. This will generate API definition with the address that needs to be known to the client consuming the API. It also solves the problems when API is running behind reverse-proxy or API Gateway (that modify the URL of the API).

kumuluzee:
  swagger:
    base-url: http://microservice.kumuluz.com/customers-service/

If kumuluzee.swagger.base-url is not set the kumuluzee.server.base-url is used as a source setting for the API URL location. If neither is set the "http://localhost:8080" is used.

Changelog

Recent changes can be viewed on Github on the Releases Page

Contribute

See the contributing docs

When submitting an issue, please follow the guidelines.

When submitting a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix.

When submitting a new feature, add tests that cover the feature.

License

MIT