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.

Sign up for GitHub

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

Jump to bottom

add apiDoc to signsfive-api #23

Open
meltedspork opened this issue Feb 5, 2018 · 5 comments
Open

add apiDoc to signsfive-api #23

meltedspork opened this issue Feb 5, 2018 · 5 comments
Labels
backend

Comments

@meltedspork
Copy link
Contributor

can use npm supported - http://apidocjs.com/#getting-started
@kratsg
Copy link
Contributor

kratsg commented Feb 5, 2018

https://github.com/fsbahman/apidoc-swagger

Yes, let's combine things accordingly. We'll want to test to make sure things are doc'd too.

@meltedspork
Copy link
Contributor Author

Can you explain why we will need both? I might be missing something about apiDoc don't have what swagger has and vice verse?

@kratsg
Copy link
Contributor

kratsg commented Feb 5, 2018

Swagger is prettier.

@kratsg
Copy link
Contributor

kratsg commented Feb 5, 2018

https://eslint.org/docs/rules/valid-jsdoc -- this can be used to test documentation is valid, but not if it exists.

@kratsg kratsg mentioned this issue Feb 5, 2018
Closed
@meltedspork
Copy link
Contributor Author

👍 sounds good. lets do that both apiDoc and swagger.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
backend
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Feature/api doc cd2bit/signsfive-api
2 participants
@kratsg @meltedspork