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

Automatic swagger conf #62

Closed
josx opened this issue May 23, 2017 · 4 comments
Closed

Automatic swagger conf #62

josx opened this issue May 23, 2017 · 4 comments

Comments

@josx
Copy link

josx commented May 23, 2017

Is there any feature to create swagger conf directly from the feathers API?

@christopherjbaker
Copy link
Contributor

christopherjbaker commented Jun 8, 2017

#68 did add some more intelligence to the default created docs, though it did not add any automatic docs. I think that would need to be integrated into each service type (ie: feathers-sequelize, feathers-elasticsearch, etc), as feathers itself does not know about the structure of the data. Personally, I do have a bit of code for my elasticsearch that generates docs based on the index mappings, though I did not integrate it into the feathers-elasticsearch module.

@daffl Would you be open to having auto-generating docs to the individual modules when feathers-swagger is in use?

@jraut
Copy link
Contributor

jraut commented Apr 25, 2018

I have a snippet which generates swagger definitions from sequelize models which is run in service definitions. I am willing to participate if this is going forward.

@gijo-varghese
Copy link

+1

@Mairu
Copy link
Collaborator

Mairu commented Jun 2, 2019

There is now the possibility to adjust the generation for different methods.
And also to generate definitions based on the service (and therefor the connected orm model).

There is space for other orm (or jsdoc) related packages, that create docs properties for services before services are consumed by feathers-swagger.

@Mairu Mairu closed this as completed Jun 2, 2019
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

5 participants