JavaJaxRS.spec.libraries.thorntail.README.mustache Maven / Gradle / Ivy

Go to download
# JAX-RS server with OpenAPI using Thorntail

## Overview
This server was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using an
[OpenAPI-Spec](https://openapis.org), you can easily generate a server stub.

This is an example of building a OpenAPI-enabled JAX-RS server.
This example uses the [JAX-RS](https://jax-rs-spec.java.net/) framework and 
the [Eclipse-MicroProfile-OpenAPI](https://github.com/eclipse/microprofile-open-api) addition.

The pom file is configured to use [Thorntail](https://thorntail.io) as application server.

{{#interfaceOnly}}
This project produces a jar that defines some interfaces.
The jar can be used in combination with an other project providing the implementation.
{{/interfaceOnly}}

{{^interfaceOnly}}
To start the server with maven, run this command:

```bash
mvn thorntail:run
```

You can then call your server endpoints under:

```
http://localhost:8080/
```

The OpenAPI specification is available at:

```
http://localhost:8080/openapi
```

{{/interfaceOnly}}