binpackageapi's Introduction

BinPackage API

This is an API for BinPackage using the ELG specification. The API is wrapped in a docker container and is implemented using fastapi.

Getting started

make build
make run

API calls

All the API calls use post and input/outputs are in a json format. Further details about the api calls are automatically generated when the container is run and can be found in /docs or /redoc

HTTP METHOD	Description
/binpackage	looks up words in BÍN and returns the result

Testing

test files can be found in tests/. There are two tests that can be performed.

Normal api tests: this is where you test the api from the running docker image
ELG api tests: this is where you run docker-compose up and get an instance as if you where running the docker image on ELG. To submit a api call you then need to send a post request to /process/service.

Acknowledgements

Reykjavik University

This ELG API was developed in EU's CEF project: Microservices at your service

Underlying tool

The underlying BinPackage is BinPackage by Miðeind, which is licensed under this MIT license. The ELG API implementation imports the corresponding PyPi package.

Recommend Projects