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

feature: add swagger documentation for API with auto-generated API docs #265

Closed
niftylettuce opened this issue Sep 7, 2017 · 1 comment
Assignees

Comments

@niftylettuce
Copy link
Collaborator

niftylettuce commented Sep 7, 2017

for example:

/*
 * @api [get] /pets
 * description: "Returns all pets from the system that the user has access to"
 * responses:
 *   "200":
 *     description: "A list of pets."
 *     schema:
 *       type: "String"
 */

api.route('/pets', function() {
    /* Pet code 😺 */
});

so we comment out our API in and then run swagger-inline and then run swagger-to-slate and swagger-codegen.

References

@niftylettuce niftylettuce modified the milestone: alpha-v1.0.0 Sep 8, 2017
@OmgImAlexis OmgImAlexis self-assigned this Sep 11, 2017
@OmgImAlexis
Copy link
Contributor

Waiting on wcandillon/swagger-js-codegen#190

@niftylettuce niftylettuce removed this from the alpha-v1.0.0 milestone Dec 14, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants