Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/baloise/corellia

B2B-interface (Web-API) specification for (insurance) contract data
https://github.com/baloise/corellia

api-rest cooperation insurance

Last synced: about 1 month ago
JSON representation

B2B-interface (Web-API) specification for (insurance) contract data

Host: GitHub
URL: https://github.com/baloise/corellia
Owner: baloise
License: apache-2.0
Created: 2019-02-20T13:44:46.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2024-08-12T12:55:47.000Z (4 months ago)
Last Synced: 2024-08-13T09:14:45.355Z (4 months ago)
Topics: api-rest, cooperation, insurance
Language: Java
Homepage:
Size: 518 KB
Stars: 5
Watchers: 15
Forks: 3
Open Issues: 22
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: docs/CODEOWNERS

Awesome Lists containing this project

README

        # corellia

[![swagger-editor](https://img.shields.io/badge/open--API-in--editor-green.svg?style=flat&label=open-api-v3)](https://editor.swagger.io/?url=https://raw.githubusercontent.com/baloise/corellia/master/docs/openapi.json)

[![swagger-editor](https://img.shields.io/badge/open--API-in--editor-green.svg?style=flat&label=open-api-v2)](https://editor.swagger.io/?url=https://raw.githubusercontent.com/baloise/corellia/master/docs/swagger.json)

[![DepShield Badge](https://depshield.sonatype.org/badges/baloise/corellia/depshield.svg)](https://depshield.github.io)

[![CI Status](https://github.com/baloise/corellia/workflows/CI/badge.svg)](https://github.com/baloise/corellia/actions)

## workspace

[![Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io#https://github.com/baloise/corellia)

## about

The project hosts a classical b2b-interface (Web-API) specification for (insurance) contract data and document exchange.

This is a java project leveraging [swagger-core](https://github.com/swagger-api/swagger-core) and a [converter](https://github.com/LucyBot-Inc/api-spec-converter) to create the OpenAPI 2.0 specs. It provides the Contracts API according to the OpenAPI Spec. This application uses JAX-RS annotated resources to resolve a valid OpenAPI definition out of Java classes representing the API

### the name

The name [Corellia](https://en.wikipedia.org/w/index.php?title=Corellia) is a reference to a fictitious planet from  StarWars: one of the first trading planets in the universe with its own [Corellian Trade Spine](https://starwars.fandom.com/wiki/Corellian_Trade_Spine).

### api specs

You can find the openapi specs in the following files:

OpenAPI v3 Specs: `docs/openapi.json`

OpenAPI v2 Specs: `docs/swagger.json`

### usage open api v3

To generate the `docs/openapi.json` OpenAPI specification, call

```

$ mvn exec:java@gen-openapi

```

Note: _(One must at least once have called `$ mvn install`, otherwise the above call won't work)_

### usage open api v2

**Firstly generate the OpenAPI v3 specs** (will be located at `docs/openapi.json`)

Then use the following call to convert the OpenAPI v2 specs (will be located at `docs/swagger.json`)

```

$ mvn exec:java@gen-swagger

```

Note: _(One must have issued `npm install` previously.)_

## releasing

Run e.g. on master: `mvn -B release:prepare` e.g. via [![Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io#https://github.com/baloise/corellia)

Subsequently the GitHub action worksflow "create release" will pick up the published tag and release and deploy the artifacts in the Github package registry.