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

Expose a REST API for the simulator #51

Open
slaperche-scality opened this issue May 14, 2018 · 1 comment
Open

Expose a REST API for the simulator #51

slaperche-scality opened this issue May 14, 2018 · 1 comment
Assignees

Comments

@slaperche-scality
Copy link
Collaborator

Currently, you can control the simulator by executing command on its prompt.
It's good for interactive use, but not that much for playing "demo scenario" or "test script".

Ideally, the simulatior should be totally controllable through a REST API (exposing all the command that exists in the shell, plus some other such as "add node", "remove node", …).

The goal of this issue is to design and implement a REST API for the simulator (TBC: it will probably rely on Swagger).

This issue is a prerequisite for #36.

@slaperche-scality slaperche-scality self-assigned this May 24, 2018
@slaperche-scality
Copy link
Collaborator Author

slaperche-scality commented Jun 1, 2018

After some digging around, things are not so bright.
I didn't find a good REST framework for us to use:

So, we will probably have to build something ourselves on top of libmicrohttpd (will create a dedicated issue for that).

As for Swagger, seems like we won't be able to benefit from the code generation from the YAML specs, because the code generator for server relies on restbed for C++.
That being said, I still think it's worth to have a Swagger spec (it will allows people to auto-generates REST clients for our API in others languages), we will have to write it by hand though (maybe with the help of https://editor.swagger.io/).

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

No branches or pull requests

1 participant