search

brighthive / data-resource-api

An elegant, opinionated framework for deploying BrightHive Data Resources with zero coding.
MIT License
4 stars 1 forks source link

Dynamically generate Swagger specification from Data Resource endpoints #7

Open gregmundy opened 5 years ago

gregmundy commented 5 years ago

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.

loganripplinger commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

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