JavaJaxRS.spec.libraries.helidon.README.mustache Maven / Gradle / Ivy
# JAX-RS server with OpenAPI using Helidon
## 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 [Helidon](https://helidon.io/) as application server.
{{#interfaceOnly}}
This project produces a jar that defines some interfaces.
The jar can be used in combination with another project providing the implementation.
{{/interfaceOnly}}
{{^interfaceOnly}}
To build the server, run this maven command (with JDK 11+):
```bash
mvn package
```
To run the server, run this maven command:
```bash
java -jar target/{{artifactId}}.jar
```
You can then call your server endpoints under:
```
http://localhost:8080/
```
You can access the OpenAPI specification at:
```
http://localhost:8080/openapi
```
{{/interfaceOnly}}