Skip to content
This repository has been archived by the owner on Apr 21, 2020. It is now read-only.

Generate autodocumentation for swagger #5

Open
danibram opened this issue Mar 17, 2017 · 3 comments
Open

Generate autodocumentation for swagger #5

danibram opened this issue Mar 17, 2017 · 3 comments

Comments

@danibram
Copy link

danibram commented Mar 17, 2017

Hi @joesonw !
First of all thank you for your awesome work. I start adding autodocumentation for the module and this issue is to disscuss about your opinion.
You can check the first try i make here:
master...danibram:add_swagger_doc
Right now i only add the basics, with this code i can generate the swagger json and i autocreate a route to return the documentation in a json, remains the route to render this with official swagger module. Its only a first step.
Do you want to put inside your module?or in a external module? Maybe in the future i need to add a decorator for custom things like descriptions etc...

Also i add a test, to try it and works fine, maybe my code is bad im not a really expert with typescript classes.

I'm looking forward to hearing from you
Thanks for your time!

@joesonw
Copy link
Contributor

joesonw commented Mar 17, 2017

@danibram Thanks bro, this is really brilliant. I'm working on a v1.0 release with a whole lot of other stuff. You can check it out at https://github.com/t2ee/vader/tree/v1.0.

you can create a PR for it.

@danibram
Copy link
Author

danibram commented Mar 17, 2017

I see that you split the vader in multiple repositories, have you consider lerna? I mean this because for me now is dificult to understand where all the functions are, and with lerna or similar libraries i can have all your modules inside a git repository, share dev libraries etc..., if you want i can help you on add lerna.
Maybe if not, i can make a PR to actual version of vader and then when you go with the 1.0 or the development start to be more stable i can migrate ( at least when i can have examples)
I can help you on development also if you need

@joesonw
Copy link
Contributor

joesonw commented Mar 18, 2017

@danibram The core functions stay lay in side this repository. The others are dependency injections and loggers. I was implementing a set of interfaces similar to spring boot(@t2ee/deathstar). While this repository plays the core part, something like JAX-RS. This repository still can be used alone as a routing service for koa. They are necessarily sub-modules of each other.

But thanks for the suggestion. I was wondering If there can be something helpful for sharing common files, .gitignore, tslint.json, etc. Without copying them around once updated.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants