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

Dynamically generate Swagger specification from Data Resource endpoints #7

Open
gregmundy opened this issue Jul 2, 2019 · 3 comments
Labels
enhancement New feature or request

Comments

@gregmundy
Copy link
Contributor

The Data Resource API should be able to dynamically generate a Swagger specification for each of the endpoints that exist within the data resource. This will enable consumers of the API to have access to the most up-to-date application documentation.

@gregmundy gregmundy added the enhancement New feature or request label Jul 2, 2019
@loganripplinger
Copy link
Contributor

This is semi related -- https://github.com/thomaxxl/safrs

SAFRS generates swagger and restful API routes when given sqlalchemy models. We can't directly use this because we are generating our own api routes but we may be able to use the sqlalchemy to swagger code in there.

@loganripplinger
Copy link
Contributor

I have written a library to handle this -- https://github.com/brighthive/convert_descriptor_to_swagger

The next step would be to integrate this and publish the swagger specs.

@loganripplinger
Copy link
Contributor

Currently there is not yet a specific demand for this so it has not been integrated.

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

No branches or pull requests

2 participants