PersonalMan - REST API

PersonalMan provides absence management for employees or volunteers. It is designed as a server application with a RESTful API which any client can then implement. This module contains the API specification in Java.

License	GNU General Public Licence
GroupId	de.davelee.personalman
ArtifactId	personalman_rest_api
Last Version	1.1.0
Release Date	Sep 12, 2020
Type	jar
Description	PersonalMan - REST API PersonalMan provides absence management for employees or volunteers. It is designed as a server application with a RESTful API which any client can then implement. This module contains the API specification in Java.
Project URL	https://www.davelee.de
Source Code Management	https://github.com/daveajlee/personalman

Download personalman_rest_api

Filename	Size
personalman_rest_api-1.1.0.pom
personalman_rest_api-1.1.0-sources.jar	8 KB
personalman_rest_api-1.1.0-javadoc.jar	420 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/de.davelee.personalman/personalman_rest_api/ -->
<dependency>
    <groupId>de.davelee.personalman</groupId>
    <artifactId>personalman_rest_api</artifactId>
    <version>1.1.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/de.davelee.personalman/personalman_rest_api/
implementation 'de.davelee.personalman:personalman_rest_api:1.1.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/de.davelee.personalman/personalman_rest_api/
implementation ("de.davelee.personalman:personalman_rest_api:1.1.0")

Apache Buildr

'de.davelee.personalman:personalman_rest_api:jar:1.1.0'

Apache Ivy

<dependency org="de.davelee.personalman" name="personalman_rest_api" rev="1.1.0">
  <artifact name="personalman_rest_api" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='de.davelee.personalman', module='personalman_rest_api', version='1.1.0')
)

Scala SBT

libraryDependencies += "de.davelee.personalman" % "personalman_rest_api" % "1.1.0"

Leiningen

[de.davelee.personalman/personalman_rest_api "1.1.0"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

personalman

PersonalMan provides absence management for employees or volunteers. It is designed as a server application with a RESTful API which any client can then implement in any programming language.

How to use

1. To use the server you need to specify the user specific configuration parameters in application.properties
2. Create an executable jar using mvn clean install.
3. Run the jar (for example in dev-test mode): java -Dspring.profiles.active=dev-test -jar personalman_server.jar

How to use the server in your client

• Option 1: Personalman is a multi-module Maven project which also contains the API defined in Java. These classes can be used to write a Java client which talks with the Personalman server. To use these libraries you can simply define the API module as a maven dependency in your Java Client.
• Option 2: Personalman comes with a Swagger API documentation which can be used to implement the API in a client on any programming language. The swagger user interface is available at: http://your-personalman-server:your-port/swagger-ui.html

Available Profiles

• dev-test - This profile activates the swagger API documentation. This works well for development and testing.

Versions

Version
1.1.0 Sep 12, 2020