Skip to content

KnowledgeCaptureAndDiscovery/OBA

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
.ci
 
 
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Ontology-Based APIs (OBA) Test

OBA reads ontologies (OWL) and generates an OpenAPI Specification (OAS). Using this definition, OBA creates a REST API server automatically.

Diagram

Quickstart

There are two option to run OBA:

  1. Download the binary.
  2. Build the binary from the repository.

Downloading binary

  1. Go the latest release
  2. Download the file with extension .jar

Building binary

  1. Clone the repository git clone https://github.com/KnowledgeCaptureAndDiscovery/OBA.git
  2. Install it using mvn package
  3. The binary is available in the target directory

Running

  1. Create the OBA config file (config.yaml) from one of the sample configuration files in the examples folder
  2. Use the configuration to run OBA with the following command:
$ java -jar oba-*-jar-with-dependencies.jar -c config.yaml

Congratulations! You have generated an Open Api Specification.

For instructions on using OBA to create your API server, go to the documentation