Skip to content

Wip: GraphQL Adapter for Entsoe Transparency Platform

License

Notifications You must be signed in to change notification settings

aignerjo/entsoe-graphql

Repository files navigation

Entsoe Logo

GraphQL Adapter for Entsoe Transparency API

Since Entsoe only provides an XML interface, which is difficult to integrate into (web) applications, this repository contains a GraphQL adapter for the Entsoe API.

Entsoe API

The Entsoe restful API Implementation Guide explains the business context and provides the use case and process sequence.

Installation with npm

$ npm install

Installation with yarn

$ yarn

Generate Typings

$ npm run prestart

After the generation you can find the typings in ./src/graphql.ts.

Running the app

To run the app you have to provide specific environment variables

Environment variable Description
ENTSOE_API_URL URL to the Entsoe Transparency API
ENTSOE_SECURITY_TOKEN Security token for the Entsoe API
PLAYGROUND GraphQL playground enabled (true, false)
DEBUG GraphQL debug enabled (true, false)
LOG_LEVEL debug, info, warn, error

Acess to Entsoe API

To use the adapter you have to provide a security token.

Run the application

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Stay in touch