Swagger #feature

[klh]

Add Swagger to AUTO document the API in any project:
https://developers.helloreverb.com/swagger/

It would go well with the overall Sails mentality.

sample in use here:
http://swagger.wordnik.com/#!/pet

[anissen]

👍

It should be configurable though; whether it should be accessible, at which route, by whom etc..

[artworkad]

👍 actually a must have

[adambiggs]

👍

Swagger has an express module that might be useful to build on.

[gregholland]

👍 An API is only as good as the documentation you provide :-)

[Postman-76]

👍

[jeremypeters]

👍

[kbsanders]

👍

[kevinwolfcr]

👍

[fehguy]

at first glance, it looks like a swagger adapter would be easy to write, where the model schemas would be marshalled to JSON schema. If the adapter can get a handle to the controllers and routes, the rest should be easy.

[mikermcneil]

👍

[opensas]

(I suspect you all know an easier way to add this nice thumbs-up picture...)

[mikermcneil]

@opensas

[mikermcneil]

but yeah srsly guys I think this would be pretty sweet.

[RWOverdijk]

I'm actually working on this already. Not using swagger, but similar idea. That's why I ran into the issue of there being duplicate routes.

If anyone feels like helping out or sharing thoughts, drop me a message.

[mikermcneil]

@RWOverdijk awesome!

[fehguy]

@RWOverdijk how about collaborating and getting this working with swagger?

[klh]

Isn't it non-core to "invent your own" whe swagger is a maintained system that could be an optional dependency instead?...just saying—
Sent from Mailbox for iPad

On Thu, Mar 6, 2014 at 9:46 PM, Tony Tam [email protected] wrote:

@RWOverdijk how about collaborating and getting this working with swagger?

Reply to this email directly or view it on GitHub:
#1094 (comment)

[RWOverdijk]

Developers are always "inventing their own" if they think that the alternatives aren't good enough.

[fehguy]

sure thing. being the swagger spec maintainer, i'm happy to help implement this with some collaboration with the sails community.

[RWOverdijk]

@fehguy We could still pull this off. I already have a list of routes, I just have to discuss which should go in, and how to gather descriptions. You could then use the data for swagger, and I can use it for Barque/Kamal.

[mikermcneil]

@fehguy appreciate that :)

Swagger looks fantastic- look forward to chatting about it soon. We mentioned a weekly hangout a while ago, and this might be a good first topic. I'll post to the google group with some suggested times later this afternoon.

[kunjee17]

Is it there yet? Or yet to be added? If it haven't implemented yet. Any guide line how to implement it?

[adilwali]

Oh man! I'm so stoked to have this!!! 👍

[mikermcneil]

guys, we're aware of this and we really want to see it happen. Check out the new usage option in routes-- the best place for this is probably a grunt task that inspects routes and blueprints. Closing for now, if anyone has a particular take on this which is different than the discussion covered here, feel free to open a new issue. Thanks!

[kunjee17]

@mikermcneil thanks for reply. Where I can found details for usage as I was unable to found anything in current or beta documentation.

[eddieajau]

@kunjee17 did you find the information for usage?

[ptos79]

This email account is inactive

http://www.wavebreakmedia.com/stock-photo-video-footage-i-74/Contact-Us.html

[kunjee17]

@eddieajau not as of now... :(

[quocvu]

When is swagger integration planned to be released? I can help if needed.
I have used the Loopback framework and really miss the API explorer.

[medokin]

+1

[karantan]

+1
Any updates on this?

[ifig]

+1

[bostrom]

I don't fully understand the last comment from @mikermcneil about the usage section, nor the reason for closing this issue. I'd also really like to see some easy way to generate a swagger.json documenting the API of my Sails project, either via a dependency or out-of-the-box. Is anyone working on it at the moment or has it been completely swept under the rug?

[flipside]

+2

[leoliew]

+1

[fehguy]

We have a lot of interest to do this. I'm happy to help contribute if someone wants to join me with some pointers on getting to the routes, etc inside of sails.

[tjwebb]

I've set up a repo based on swagger-express: https://github.com/tjwebb/swagger-sails. I'd love to get some help on it. Basically my plan would be to expose the underlying express object in sails to swagger-express and go from there. Maybe that's all it takes to get a decent first version up and running, and then we can get more detailed metadata from waterline and so forth. Sound good?

sails's express instance is sails.hooks.http.app

[jfexyz]

Just FYI, swagger-express only works with Swagger 1.2...

[tjwebb]

Ah ok, looks like forking https://github.com/paulhill/swagger-n will be a better way to start then.

[fehguy]

This is the direction swagger for node has been going:

https://github.com/swagger-api/swagger-codegen/tree/master/samples/server/petstore/nodejs

This uses the swagger specification (JSON format in this example) as the DSL that routes http requests to a controller.

It's relying on middleware from the apigee-127 project by @whitlockjc. I believe that with this--and the hooks into sails routing may be a killer combo. I'll dig into the sails router shortly.

BTW the swagger-tools project works with both 1.2 and 2.0 specs, and is thoroughly tested.

[285858315]

+1

[dinana]

@tjwebb @fehguy : What's the latest direction here and how can I help?

[tjwebb]

At this point we're looking for a team of community members to help out. It looks like there's a ton of interest here, we're just swamped at the moment at Balderdash. I think @renanvieira wants to help out too.

Do you guys want to fork https://github.com/tjwebb/sails-swagger and get started there? A basic API generator would be an awesome first step :) I can help out here and there where I can, and review PRs

Here are some examples: https://github.com/swagger-api/swagger-spec#nodejs

Feel free to file issues, requests, ideas, and comments in that repository. Thanks!

[ifig]

I am going to take a look at it, I see swagger as a documentation tool more than an API generator, and that's where my focus will go.

[Cooker-Monster]

Hi !
Could be very smart indeed : very fast API code thanks to Sails and nice API browser thanks to Swagger ...
By the way, Swagger is going further than an Api doc tool and Sails generator from Swagger Specification 2.0 makes sense to me.
My 2 cents !

[armellarcier]

Yet another +1

[nnn-gif]

+1

[dlai0001]

👍 love to see swagger in Sails.

[whitlockjc]

I've just released sway, the API behind swagger-tools, and the plan is to create some sway-based middleware/plugins/integrations for Connect, Express, Hapi, Restify and Sails. I'll update this issue as things progress.

[tjwebb]

Hey guys,

I built a swagger sails hook that generates a Swagger 2.0 document: https://github.com/tjwebb/sails-swagger

It's alpha-quality at this point, but it basically works.

[fehguy]

This is awesome, thank you!

[yz89]

@tjwebb thank you!

[orhemi]

@tjwebb Thanks for your work !
But, it's not working with sails v0.11.

There is any hope to see it working soon?

[tjwebb]

It currently only works on master, I hope to see the latest sails released
soon.

On Tue, Sep 29, 2015 at 4:50 AM, orhemi [email protected] wrote:

@tjwebb https://github.com/tjwebb Thanks for your work !
But, it's not working with sails v0.11.

There is any hope to see it working soon?

—
Reply to this email directly or view it on GitHub
#1094 (comment).

[arnthorsnaer]

Looking forward to trying out swagger-sails when sails.js 0.12 is released

[theoomoregbee]

anyone here can check out this library i think it better solve the problem and open for contributions

https://github.com/theo4u/sails-hook-swagger-generator