Skip to content

Latest commit

 

History

History
222 lines (162 loc) · 9.21 KB

README-local.md

File metadata and controls

222 lines (162 loc) · 9.21 KB
Raw

HuC Editor API Service Setting

This part describes how to set up and use a local development environment for HuC Editor API Service.

NOTE: outdated, these steps are now done by the Docker setup

Requirements

The HuC API Service uses several Python frameworks:

  • Poetry. Package management is crucial in Python to ensure scripts and code run smoothly. A dependency manager like Python Poetry facilitates specifying, installing, and resolving external packages for projects.
  • FastAPI. As the name suggests, FastAPI is primarily used for rapidly creating API endpoints. It is a modern, high-performance web framework for building APIs with Python, designed for speed, ease of use, and automatic documentation generation.
  • Dynaconf. Dynaconf provides dynamic configuration for Python applications. It can read settings from various sources, including environment variables, files, configuration servers, vaults, and more.

It is assumed that you are working in a Mac OS X environment.

  • Brew, to install some of the other stuff: see brew, if you haven't installed it yet.
  • Git (brew install git).
  • Docker (brew install docker)
  • Poetry: (brew install poetry or curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -.)

Settings

The HuC Editor API Service uses Dynaconf to manage its settings. It splits into multiple toml files.

  • settings.toml, contains the base settings
  • .secrets.toml, contains all secrets

In the settings.toml file, configurations are divided into multiple environment sections: [default, development, testing, production]. The default settings are always loaded and typically include dynamic parts using @format. The development and production sections contain values specific to their respective environments.

The example below demonstrates how dynamic settings operate. The metadata directory varies depending on the current environment.

[default.keycloak]
    url="http://localhost:9090"
    realms="huc_editor"
    client_id="huc-auth"

[development.keycloak]
    url="https://keycloak.dansdemo.nl"
    realms="huc_editor"
    client_id="huc-auth"

[production.keycloakd]
    url="https://keycloak.dans.knaw.nl"
    realms="huc_editor"
    client_id="huc-auth"

Building HuC Editor API Service

poetry install; poetry update; poetry build; docker build --platform linux/amd64 --no-cache -t ekoindarto/huc-editor-service:0.1.7 -f Dockerfile . ; docker run -v ./conf:/home/dans/huc-editor-service/conf -d -p 1210:1210 --name huc-editor-service ekoindarto/huc-editor-service:0.1.7

Notes:

The image tag version must match the version specified in both the pyproject.toml file and the ARG version in the Dockerfile. e.g.:

huc-editor-service:0.1.7:

pyproject.toml

[tool.poetry]
name = "huc-editor-service"
version = "0.1.7"

Dockerfile

FROM python:3.12.3-bookworm

ARG VERSION=0.1.7

OpenAPI Specification

The OpenAPI Specification for the HuC Editor Service can be found at the following URLs:

Testing

CURL Examples for Public endpoints.

This section provides examples of curl commands that can be used to interact with the endpoints.

  • /info endpoint: This endpoint returns the service name and version.

    curl -X GET https://huc-editor-service.labs.dansdemo.nl/info

  • /profile/{id} endpoint: This endpoint returns a profile based on its ID in XML format.

    curl -X GET -H "Accept: application/xml" https://huc-editor-service.labs.dansdemo.nl/profile/clarin.eu:cr1:p_1653377925727

  • /profile/{id}/tweak endpoint: This endpoint is used to tweak a profile based on its ID.

    curl -X GET https://huc-editor-service.labs.dansdemo.nl/profile/clarin.eu:cr1:p_1653377925727/tweak

  • /{app_name} endpoint: This endpoint is used to read an application based on its name.

    curl -X GET https://huc-editor-service.labs.dansdemo.nl/vlb

  • /{app_name}/record/{id} endpoint: This endpoint is used to get a record of an application based on the application's name and the record's ID.

    curl -X GET https://huc-editor-service.labs.dansdemo.nl/vlb/record/your_record_id

  • /{app_name}/record/{id}/resource/{resource_id} endpoint: This endpoint is used to get a resource of a record of an application based on the application's name, the record's ID, and the resource's ID.

    curl -X GET https://huc-editor-service.labs.dansdemo.nl/vlb/record/your_record_id/resource/your_resource_id

  • /cdn/huc-editor/{version} endpoint: This endpoint is used to get the CDN of the HuC Editor based on its version.

    curl -X GET https://huc-editor-service.labs.dansdemo.nl/cdn/huc-editor/your_version

CURL Examples for Protected endpoints with API Key

  • /profile/{id} POST endpoint: This endpoint is used to create a profile based on its ID.

    curl -X POST -H 'accept: application/json' -H 'Authorization: Bearer YOUR_API_KEY' https://huc-editor-service.labs.dansdemo.nl/profile/clarin.eu:cr1:p_1653377925727

  • /profile/{id} DELETE endpoint: This endpoint is used to delete a profile based on its ID.

    curl -X DELETE -H 'accept: application/json' -H 'Authorization: Bearer YOUR_API_KEY' https://huc-editor-service.labs.dansdemo.nl/profile/clarin.eu:cr1:p_1653377925727

  • /profile/{id}/tweak PUT endpoint: This endpoint is used to modify a profile tweak based on its ID.

    curl -X PUT -H 'accept: application/json' -H 'Authorization: Bearer YOUR_API_KEY' https://huc-editor-service.labs.dansdemo.nl/profile/clarin.eu:cr1:p_1653377925727/tweak

  • /profile/{id}/tweak/{tweak_id} POST endpoint: This endpoint is used to create a profile tweak based on its ID and tweak ID.

    curl -X POST -H 'accept: application/json' -H 'Authorization: Bearer YOUR_API_KEY' https://huc-editor-service.labs.dansdemo.nl/profile/clarin.eu:cr1:p_1653377925727/tweak/your_tweak_id

  • /profile/{id}/tweak/{tweak_id} DELETE endpoint: This endpoint is used to delete a profile tweak based on its ID and tweak ID.

    curl -X DELETE -H 'accept: application/json' -H 'Authorization: Bearer YOUR_API_KEY' https://huc-editor-service.labs.dansdemo.nl/profile/clarin.eu:cr1:p_1653377925727/tweak/your_tweak_id

  • /{app_name} POST endpoint: This endpoint is used to create an application based on its name.

    curl -X POST -H 'accept: application/json' -H 'Authorization: Bearer YOUR_API_KEY' https://huc-editor-service.labs.dansdemo.nl/vlb

  • /{app_name}/record PUT endpoint: This endpoint is used to modify a record of an application based on its name.

    curl -X PUT -H 'accept: application/json' -H 'Authorization: Bearer YOUR_API_KEY' https://huc-editor-service.labs.dansdemo.nl/vlb/record

  • /{app_name}/record/{id} POST endpoint: This endpoint is used to create a record of an application based on the application's name and the record's ID.

    curl -X POST -H 'accept: application/json' -H 'Authorization: Bearer YOUR_API_KEY' https://huc-editor-service.labs.dansdemo.nl/vlb/record/your_record_id

  • /record/{id} DELETE endpoint: This endpoint is used to delete a record based on its ID.

    curl -X DELETE -H 'accept: application/json' -H 'Authorization: Bearer YOUR_API_KEY' https://huc-editor-service.labs.dansdemo.nl/record/your_record_id

  • /{app_name}/record/{id}/resource PUT endpoint: This endpoint is used to create a resource of a record of an application based on the application's name and the record's ID.

    curl -X PUT -H 'accept: application/json' -H 'Authorization: Bearer YOUR_API_KEY' https://huc-editor-service.labs.dansdemo.nl/vlb/record/your_record_id/resource

  • /record/{id}/resource/{resource_id} POST endpoint: This endpoint is used to create a resource of a record based on the record's ID and the resource's ID.

    curl -X POST -H 'accept: application/json' -H 'Authorization: Bearer YOUR_API_KEY' https://huc-editor-service.labs.dansdemo.nl/record/your_record_id/resource/your_resource_id

  • /record/{id}/resource/{resource_id} DELETE endpoint: This endpoint is used to delete a resource of a record based on the record's ID and the resource's ID.

    curl -X DELETE -H 'accept: application/json' -H 'Authorization: Bearer YOUR_API_KEY' https://huc-editor-service.labs.dansdemo.nl/record/your_record_id/resource/your_resource_id

…/profile/<id>

POST

curl -X 'POST' 'https://huc-editor-service.labs.dansdemo.nl/profile/clarin.eu:cr1:p_1653377925727' -H 'accept: application/json' -H 'Authorization: Bearer YOUR_API_KEY'