Technical Docs

5.1 - APIGenerator (Object)

OntologyToAPI.core.APIGenerator.APIGenerator

Methods

APIGenerator(showLogs: bool) -> OntologyToAPI.core.APIGenerator.APIGenerator (Constructor)

This method instantiate the Generator class.

• showLogs: Show the serialisation and configuration process when handling the ontologies and generating the API.

APIGenerator.load_ontologies(paths: List[str]) -> None

This method is used to load the ontologies in the generator.

• paths: Load a list of ontology files in .rdf .owl or .ttl.

APIGenerator.serialize_ontologies() -> None

This method serialize the ontologies, and execute verifications in the ontology specifications.

APIGenerator.generate_api_routes() -> fastapi.FastAPI

This method configures the api routes and return an FastAPI object.