An open API service indexing awesome lists of open source software.

https://github.com/inpercima/rest-api

Java REST-API for specific apps.
https://github.com/inpercima/rest-api

java java17 rest rest-api

Last synced: 5 months ago
JSON representation

Java REST-API for specific apps.

Awesome Lists containing this project

README

          

# rest-api

[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md)
[![Release](https://jitpack.io/v/inpercima/rest-api.svg)](https://jitpack.io/#inpercima/rest-api)
![Github Action CI](https://github.com/inpercima/rest-api/workflows/CI/badge.svg)

Java REST-API for specific apps.

## Prerequisites

### Java

* `jdk 21` or higher

## Getting started

```bash
# clone project
git clone https://github.com/inpercima/rest-api
cd rest-api
```

## Usage

### Package

```bash
# package
./mvnw clean package

# package without tests
./mvnw clean package -DskipTests
```

### Install via jitpack

Add `jitpack.io` as repository to your project, for maven like

```xml


jitpack.io
https://jitpack.io

```

Add `rest-api` as dependency to your project, for maven like

```xml

com.github.inpercima
rest-api
v1.0.3

```

### Install via github repository

Update or create settings.xml in your `.m2` folder

```xml


github



github


central
https://repo1.maven.org/maven2


github
https://maven.pkg.github.com/inpercima/*

true






github
USERNAME
PERSONAL_ACCESS_TOKEN

```

Replace `USERNAME` with your github username.
Replace `PERSONAL_ACCESS_TOKEN` with your personal access tokens you have to create in github with the scope `read:packages`.

Add `rest-api` as dependency to your project, for maven like

```xml

net.inpercima
rest-api
1.0.3

```