This project is a node.js middleware API for VDJServer V2 clients using express-openapi and the Tapis V3 API. The
primary client of the API is the VDJServer Web Portal. Another
client is vdjserver-tools for doing command-line automation. It provides some public
endpoints and some endpoints for admin accounts but most of the endpoints are for user accounts.
VDJServer Web API is a submodule in vdjserver-web, which has a set of docker compose configurations for building and running the VDJServer Web Portal.
Edit the environment configuration file. Refer to the VDJServer administration guide for information about the environment configuration variables.
cp .env.defaults .env
nano .env
OpenAPI 3 spec is available in the source code at vdjserver-web-api/swagger/vdjserver-api.yaml
With a local running API, there is a swagger UI available.
The staging server currently has a beta release of the swagger UI.
There is a test suite, but it needs to be documented and automated.