README.md

Ontology-Based APIs (OBA)

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

Quickstart

There are two option to run OBA:

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

Pre-requisites

Due to recent versions of the OpenAPI generator being built with Java 11, you will need Java 11 or higher to run OBA v3.7.0. The current recommended distribution of Java 11+ JDKs (and "JREs") is at Adoptium's releases page.

Java versions higher than 11 are also available to use. Java 11 is simply the minimum version.

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

Citation

Please cite our work as follows:

@inproceedings{garijo2020OBA,
	title        = {{OBA}: An Ontology-Based Framework for Creating REST APIs for Knowledge Graphs},
	author       = {Garijo, Daniel and Osorio, Maximiliano},
	booktitle={International Semantic Web Conference},
	pages={48--64},
	year={2020},
    doi={https://doi.org/10.1007/978-3-030-62466-8_4},
	organization = {Springer, Cham},
    isbn={978-3-030-62466-8}
}