A SmartAPI Portal for NCATS Biomedical Data Translator
This program focuses on building tools for massive knowledge integration in support of biomedical and translational science. Learn more
BUILD A TRANSLATOR KNOWLEDGE PROVIDER API
filter_1 Create a Knowledge Provider API
To create a Knowledge Provider (KP) API that's ready to be integrated into the Translator ecosystem, you can:
- done Build a REST API with JSON output (use your own preferred structure).
- done Build a ReasonerStdAPI, follow the instructions here .
Tip: You may consider using BioThings SDK to build your KP APIs. BioThings SDK will create a high-quality APIs following all these best-practices by default. If you need the help, please contact BioThings team (aka "Service Provider" KP team in Translator).
filter_2 Document your API with metadata
To take full advantage of SmartAPI and make your KP API compatible with Meta-KG you will need to:
- done Create your API metadata following the latest OpenAPI v3 API specification
- done Add semantics of your API's inputs and outputs using the SmartAPI extensions. Learn more.
You can use this editor build to write/edit your API metadata. You can start with an existing metadata example from mygene.info API. The editor automatically validates your API metadata and gives a live preview of auto-generated API documentation.
This guide can also guide through the process/tools on how to create your OpenAPI v3 API metadata or how to upgrade an existing Swagger v2 API metadata to OpenAPI v3.
filter_3 Register your API
The registry provides useful information and operation documentation, API status, editing tools and many other neat features!