Data

Tools

Indexes

Applications

Experiments

Open Source Science

oba

Ontology based APIs

https://github.com/knowledgecaptureanddiscovery/oba

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 5 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.0%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Ontology based APIs

Basic Info
  • Host: GitHub
  • Owner: KnowledgeCaptureAndDiscovery
  • License: apache-2.0
  • Language: HTML
  • Default Branch: master
  • Size: 17.9 MB
Statistics
  • Stars: 40
  • Watchers: 7
  • Forks: 12
  • Open Issues: 57
  • Releases: 21
Created about 7 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Changelog License Citation

README.md

Ontology-Based APIs (OBA) Test DOI

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.

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:

bash $ 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} }

Owner

  • Name: KnowledgeCaptureAndDiscovery
  • Login: KnowledgeCaptureAndDiscovery
  • Kind: organization

Knowdledge Capture and Discovery Group, at ISI (USC)

Citation (CITATION.cff) 

title: "OBA: Ontology-Based APIs"
license: Apache-2.0
authors:
  - family-names: Osorio
    given-names: Maximiliano
    orcid: "https://orcid.org/0000-0002-3611-6510"
  - family-names: Garijo
    given-names: Daniel
    orcid: "https://orcid.org/0000-0003-0454-7145"
cff-version: 1.2.0
message: "If you use this software, please cite both the article from preferred-citation and the software itself."
preferred-citation:
  authors:
    - family-names: Osorio
      given-names: Maximiliano
    - family-names: Garijo
      given-names: Daniel
  title: "OBA: An Ontology-Based Framework for Creating REST APIs for Knowledge Graphs"
  type: article
  year: 2021
  doi: 10.1007/978-3-030-62466-8_4
identifiers:
  - description: "Collection of archived snapshots for OBA"
    type: doi
    value: 10.5281/zenodo.6639554

GitHub Events

Total
  • Issues event: 1
  • Watch event: 7
  • Issue comment event: 1
  • Pull request event: 2
  • Fork event: 1
Last Year
  • Issues event: 1
  • Watch event: 7
  • Issue comment event: 1
  • Pull request event: 2
  • Fork event: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 1
  • Total pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 year
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 3.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • tanosk895 (1)
  • cweedall (1)
Pull Request Authors
  • cweedall (9)
  • dependabot[bot] (2)
Top Labels
Issue Labels
Pull Request Labels
dependencies (2)

Dependencies

pom.xml maven
  • com.github.jsonld-java:jsonld-java 0.11.1
  • commons-cli:commons-cli 1.3.1
  • net.sourceforge.owlapi:owlapi-api 5.1.10
  • net.sourceforge.owlapi:owlapi-apibinding 5.1.10
  • net.sourceforge.owlapi:owlapi-compatibility 5.1.10
  • org.apache.maven.plugins:maven-dependency-plugin 3.1.1
  • org.json:json 20190722
  • org.openapitools:openapi-generator 4.0.0
  • org.yaml:snakeyaml 1.25
  • junit:junit 4.13.1 test
docs/requirements.txt pypi
  • mkdocs-material *
.github/workflows/build.yaml actions
  • actions/checkout v3 composite
  • actions/setup-java v3 composite