bisq-network / bisq2

GNU Affero General Public License v3.0
167 stars 62 forks source link

Implement REST API #265

Open chimp1984 opened 2 years ago

chimp1984 commented 2 years ago

We got the skeleton/prototype for a REST API (http://167.172.189.9:8080/swagger-ui/). Now we are looking for a developer adding more endpoints and making it production ready. It should come with some useful scripts for demonstrating real life usage (e.g. post a chat message, create a user profile,...).

ghost commented 2 years ago

I'm interested - started work on that on my rest-api branch.

chimp1984 commented 2 years ago

@salokiam has already committed to that task. Was quick...

ghost commented 2 years ago

Got it, in case of need I'm in reserve

HenrikJannsen commented 1 month ago

As we use now the Rest API for seed and oracle monitoring we should get it into a more clean state.

Tasks:

Existing use case: Reporting data for monitoring. The other endpoints have been just added as POC.

Planned used case: Bisq Easy mobile which requests offer date, user profile data and other public network data which is needed for a minimal Bisq Easy version. Furthermore support for private messages and mailbox messages.

Extension: For push messages we should add support for websockets. It is likely an independent tech stack and might only partially overlap with the REST API. That part can be done as a second stage as well, but would be good to have a clear picture of a potential solution.

Tor support: The rough idea for the mobile app is that Tor can be optionally supported at least for Android (iOS tor support is problematic). So the chosen solutions should work well with Tor.