Skip to content

This repository contains the RAML 1.0 specification of the LightningHub API. For a HTML documentation visit:

License

Notifications You must be signed in to change notification settings

yojoe/lightninghub-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LightningHub API Specification

The LightningHub API allows you to connect your Bitcoin/Lightning Bluewallet App and serve multiple user accounts via a shared Lightning Node.

This repository only contains the API specification in the RAML 1.0 format, which can be used to generate various code stubs (client and server) and human-readable documentation (e.g. HTML).

Viewing the API documentation

Please see the static index.html in the /docs folder for a generated HTML documentation (using raml2html). The HTML documentation can be re-generated using the raml2html.sh file in the /scripts folder.

API Spec design & development

Please see Atom based http://apiworkbench.com/ for tools to work with RAML 1.0 files. For more tools have a look at https://raml.org/projects.

Please have a look into the raml10/api.raml file, which is the root document (starting point) of the LightningHub API specification.

Code generation

Client and server code can be automatically generated for various programming languages and frameworks. Please see the /docs folder for details.

About

This repository contains the RAML 1.0 specification of the LightningHub API. For a HTML documentation visit:

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published