Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

REST API #1

Closed
8 tasks done
mvandeberg opened this issue May 3, 2024 · 1 comment
Closed
8 tasks done

REST API #1

mvandeberg opened this issue May 3, 2024 · 1 comment
Labels

Comments

@mvandeberg
Copy link
Member

mvandeberg commented May 3, 2024

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
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants