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

Swagger Definition? #17

Open
senften opened this issue Feb 28, 2017 · 3 comments
Open

Swagger Definition? #17

senften opened this issue Feb 28, 2017 · 3 comments
Assignees
Labels

Comments

@senften
Copy link

senften commented Feb 28, 2017

Would you be willing to commit your swagger definition file for your API? I have been reviewing your client example and would find that definition helpful.

@sebastianhaas
Copy link
Owner

You could just npm start it and navigate to http://0.0.0.0:3000/explorer/swagger.json

A YAML version is available by running slc loopback:export-api-def from the root directory (strongloop package is required for slc).

Is there a reason this is not feasible for you? I could commit a definition file, but then again, I have to make sure it stays up to date. :)

@sebastianhaas sebastianhaas self-assigned this Mar 2, 2017
@senften
Copy link
Author

senften commented Mar 2, 2017

No, thank you for the offer; this will work for my purposes. I hadn't considered that as I was navigating through the source, but it leads me to another question for you.

Are you using swagger and swagger codegen to update your API and, if so, what is your process/methodology? Do you export the definition at the time you want to update it, edit it, and regenerate using codegen?

@sebastianhaas
Copy link
Owner

sebastianhaas/medical-appointment-scheduling contains a shell script to regenerate the definition.

It's really just for playing around, so, as you can see, you need to have swagger-codegen on the specified path and an instance of this server running.

Could you tell me what your are planning to do? Maybe there is a more elegant way. I have done it differently in a few other projects.

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

No branches or pull requests

2 participants