Swagger / Shred clobbers RequireJS

[martypitt]

shred.bundle.js redfines require, as a global.

This makes using swagger-js in a browser with RequireJS very difficult.

Is it possible to seperate the dependency on shred for node-only implementations, and use something a little more browser-friendly?

[fehguy]

eh I didn't know it was redefining that. It must be in the bundle.

I believe you can exclude the shred.bundle.js and force useJQuery=true when initializing the client.

[NickPadilla]

Hello,

I am having the same issue. The 'useJQuery' field isn't documented anywhere and so not sure how to use it. I have tried just using the individual shred files but that doesn't work. Please help provide a work around. It might be best to just fix the problem by ensuring your using a different namespace. Please advise.

[NickPadilla]

Hey @martypitt,

I am wondering if you were able to figure out a workaround for this issue. If so please post here.

Thanks for your time!

[fehguy]

Hi, I believe you can include the shred libraries instead of shred.bundle to avoid this. Can you try and report back?

[NickPadilla]

Hey @fehguy,

I have tried this and it doesn't work outright. When the bundle gets built it adds the needed deps to the file. However it looks like some of them are mocks so that it will work in the browser space, since it was built for node to begin with. I also see that all the shred libraries expect to be built into require.define() which gets injected with 'module' object that exposes the lib functionality. There seems to be some work involved in getting this all working with RequireJS. If anyone has any other ideas, that can be tried out relatively quickly, I'd be happy to try them out.

[NickPadilla]

Hey @fehguy

I have looked at using the 'useJQuery' but the usage is spotty. Is there a way we can hijack the 'operation' in the 'SwaggerRequest' object when making a request? I'd like to ensure all request go out using jquery. I have the initial api-docs call using jquery but can't seem to get other requests to use jquery.

Also, i found a bug in the use of the useJQuery field. When creating the Swagger instance we are not getting the useJQuery from the options and setting it in the instance.

[NickPadilla]

Hey Tony,

Ok, it seems that there is an expectation that the 'operation' object contains the 'useJQuery' field but it is never created and thus not ever true. Going to look into this a bit more tonight, hopefully i can come up with a pull request that will have this fixed.

[NickPadilla]

Hey @fehguy

I think i have this fixed. However, I am unsure about the 'operation.resource' usage but it is where the 'useJQuery' field was located. I have this fixed as of now, on my side, so any changes needed please let me know. Looking forward to having this merged.

Thanks!

[fehguy]

merged

[NickPadilla]

Hey @fehguy

Thanks a bunch! One last question, when do you think you might branch this change? This is so I don't get stuck on master, b/c I forgot it was in use.

Thanks again for the quick turn around!

[fehguy]

It's in version 2.0.31 I believe, which is master