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

Provide an OpenAPI specification for the API #8

Open
th0mk opened this issue Oct 12, 2020 · 1 comment
Open

Provide an OpenAPI specification for the API #8

th0mk opened this issue Oct 12, 2020 · 1 comment

Comments

@th0mk
Copy link

th0mk commented Oct 12, 2020

Use-Case Description

When the API releases, it would be nice to have an OpenAPI specification available. This allows many useful things and makes implementation much easier. For example, people would be able to automatically generate client libraries using autorest

There are tools available to generate this specification automatically, but I'm not that familiar with rust so not sure if this is an easy thing to do.

@aramperes
Copy link
Member

Sadly there's no production-ready option to generate OpenAPI specifications automatically with our stack (actix-web). paperclip seems promising but it's a bit early to use in production.

Of course it would still be possible to write one manually, at least when v1beta is stabilized to v1 and there won't be any more major changes.

@aramperes aramperes added this to the v1 milestone Oct 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants