koinos / koinos-rest

The rest microservice provides a REST API for interacting with the Koinos node.
Other
0 stars 1 forks source link

REST API #1

Closed mvandeberg closed 1 month ago

mvandeberg commented 2 months ago

We want to add a REST API to Koinos. The two big reasons behind this are:

  1. Swagger documentation of a REST API makes documenting the API easy with great features (such as embedded interaction).
  2. A REST API should be designed to be more user friendly than the JSON-RPC or gRPC APIs. This is needed for improving data access to exchanges, CMC, and CG.

We are going to use Roamin's REST service as a base for our REST API. It is well structured, documented, and works. No need to reinvent the wheel when we have something working already. But there are changes we want to make to his API.

mvandeberg commented 1 month ago

Removing #3 as a requirement for this story. It is a nice to have.