Setae API

API middleware to support LTS workflows in FOLIO.

Prerequisites

• Docker

  If using Docker Desktop, ensure filesystem sharing for macOS or shared drives for Windows is configured properly to support mounting files at the path of your working copy for this repo.

• Docker Compose
• FOLIO user account with necessary permissions

  see folio-permset.json

Dev Quickstart

1. Clone this repo

   git clone git@github.com:cul-it/setae-api.git
   cd setae-api

2. Setup environment variables

   cp .env.example .env

   Replace CHANGEME placeholders in .env with appropriate values

3. Build the Docker Image

   docker-compose build

4. Start the Dev Environment

   docker-compose up

Once the dev environment has started, the API should be running at http://localhost.

You can visit the generated API documentation at http://localhost/docs.

Stopping the Dev Environment

docker-compose down

If running in the foreground, simply press CTRL + C

Running arbitrary commands

• Get a shell into your running application container

  docker-compose exec api bash
  

/items/{barcode} endpoint for SpineOMatic spine labeler

Submit a GET request to the http://localhost/items/{barcode} using the barcode of a known item in your FOLIO tenant. This will return XML ready to be consumed by SpineOMatic.

Review the SpineOMatic wiki for installation and settings documentation. More specific details on configuring SpineOMatic to use this FOLIO API middleware will be provided here in the near future.

You can request the original, unmodified JSON from FOLIO using the format parameter:

http://localhost/items/{barcode}?format=json

Refer to the generated API documentation for the /items endpoint for all available parameters

Deploying to Kubernetes

After merging a branch into main, a Github action should generate a new image for deployment in a FOLIO Kubernetes cluster. To deploy the pod, run the following commands from the FOLIO Helm repository:

• Uninstall the pod helm -n $namespace uninstall setae-api
• Re-install the pod helm -n $namespace upgrade -f {path-to-folio-k8s}/setae-api/setae-api-folio-test.yaml setae-api setae-api/