mirror of https://github.com/ACINQ/eclair.git synced 2024-11-20 10:39:19 +01:00

araspitzu a4b94004e4 API: use form data instead of JSON-RPC (#894 )

Port the existing API functionalities over a new structure of HTTP endpoints, with the biggest difference being the usage of **named parameters** for the requests (responses are unchanged). RPC methods have become endpoints and the parameters for each are now passed via form-params (clients must use the header "Content-Type" : "multipart/form-data"), this allows for a clearer interpretation of the parameters and results in more elegant parsing code on the server side. It is possible to still use the old API version via a configuration key.

Old API can be used by setting `eclair.api.use-old-api=true`.

2019-03-26 18:10:09 +01:00

1.2 KiB

Raw Blame History

Building Eclair

Requirements

OpenJDK 11.
Maven 3.6.0 or newer
Docker 18.03 or newer (optional) if you want to run all tests

⚠️ You can also use Oracle JDK 1.8 to build and run eclair, but we recommend you use Open JDK11.

Build

To build the project, simply run:

$ mvn install

Other build options

To skip all tests, run:

$ mvn install -DskipTests

To only build the eclair-node module

$ mvn install -pl eclair-node -am -DskipTests

Building the API documentation

Slate

The API doc is generated via slate and hosted on github pages. To make a change and update the doc follow the steps:

git checkout slate-doc
Install your local dependencies for slate, more info here
Edit source/index.html.md and save your changes.
Commit all the changes to git, before deploying the repo should be clean.
Push your commit to remote.
Run ./deploy.sh
Wait a few minutes and the doc should be updated at https://acinq.github.io/eclair

1.2 KiB Raw Blame History