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

Consider implementing OpenAPI (Swagger) specification #4

Closed
frol opened this issue Mar 8, 2017 · 4 comments
Closed

Consider implementing OpenAPI (Swagger) specification #4

frol opened this issue Mar 8, 2017 · 4 comments

Comments

@frol
Copy link

frol commented Mar 8, 2017

You already have annotations, which is great. Using the annotations you can build OpenAPI description of the API endpoints, which can be used to generate API clients in a number of programming languages.

OpenAPI: https://www.openapis.org
Swagger examples: http://swagger.io

@abonander
Copy link
Owner

Unless I'm fundamentally misunderstanding something, this seems like it can be implemented with a build script that generates service!{} declarations.

@frol
Copy link
Author

frol commented Mar 8, 2017

I mean the other way around, allow to generate a swagger.json from the server code inspection, see this example written in Python: https://github.com/frol/flask-restplus-server-example

@abonander
Copy link
Owner

Sorry, this is a client framework. I've only just realized I may not have made that very clear.

@frol
Copy link
Author

frol commented Mar 8, 2017

Ah... I felt like I miss something... :) Sorry for bothering you.

@frol frol closed this as completed Mar 8, 2017
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

2 participants