search

Onto-Med / top-api

REST API of the TOP Framework
https://onto-med.github.io/top-api/
MIT License
0 stars 1 forks source link
openapi-specification phenotyping

readme

TOP API

This repository contains the OpenAPI 3 specification of the TOP framework. Please see top-deployment for an onverall description of the framework. The schema file is located at schemas/top-api.yml

DOI Swagger UI

Publish snapshots Publish packages and create release

Usage

Spring Boot Skeleton

  1. Add maven dependency 
    <dependency>
  <groupId>care.smith.top</groupId>
  <artifactId>top-api</artifactId>
  <version><!-- the version number --></version>
</dependency>
  2. Add annotation @ComponentScan("care.smith.top.backend") to your application class.
  3. Create implementations for the delegate interfaces in care.smith.top.backend.api (e.g., EntityApiDelegate).

Because the Maven package is hosted at GitHub Packages, you need to make some modifications to your Maven installation in order to download and install the package. Please follow the Authenticating to GitHub Packages instructions.

Typescript Axios

  1. Add the file .npmrc to the project folder, with the following content: 
    @onto-med:registry=https://npm.pkg.github.com
  2. Authenticate to GitHub Packages (you will be prompted for username and password aka. personal access token, see Authenticating to GitHub Packages): 
    npm login --scope=@onto-med --registry=https://npm.pkg.github.com
  3. Add @onto-med/top-api as dependency, e.g.: 
    yarn add @onto-med/top-api

Contribution and Development

Please see our Contributing Guide.

License

The code in this repository and the packages care.smith.top:top-api and @onto-med/top-api are licensed under MIT.