Skip to content
Chris Day edited this page Feb 1, 2026 · 4 revisions

OntoPortal SDK + OpenAPI

Purpose

This wiki provides a complete developer portal for the OntoPortal/BioPortal REST API. It serves three audiences: application developers, API integrators/tool builders, and ontology/semantic data specialists.

What is OntoPortal / BioPortal?

OntoPortal is a platform for hosting and accessing biomedical ontologies. Its REST API exposes ontologies, classes (concepts), mappings, annotations, and recommendations as hypermedia-linked resources. Official API docs: https://data.bioontology.org/documentation.

What this project delivers

  • A reusable client SDK (Python) for the OntoPortal/BioPortal REST API.
  • A complete OpenAPI 3.1 specification with modeled schemas, parameters, and hypermedia behavior.

How this wiki is organized

  • Getting Started: auth, first call, environment setup.
  • Architecture: system context, SDK design, error handling strategy.
  • OpenAPI: base URL, security schemes, Swagger/Redoc/Postman usage.
  • Endpoint Guides: per-endpoint details and pitfalls.
  • Recipes: task-oriented usage patterns.
  • Semantics: ontology concepts and JSON-LD interpretation.
  • Operations: pagination, errors, testing, release strategy, contribution.

Quick links

Clone this wiki locally