Documentation

[briananderson1222]

This project could really benefit from some extra documentation. For example, digging around in the code I found out that I can actually implement my own HTTP Client by passing in a client option which I have done to wrap angular's $httpProvider for my angular implementation so that my service calls can be intercepted easily using a single interceptor.

[fehguy]

Thanks, and agreed that documentation can be improved.

[Ondoher]

In fact, this is such a useful feature, it should be made a first class citizen of the API. To get this to work I had to override SwaggerHttp.prototype.execute and modify opts.client. Not the most elegant way of handling this.

[briananderson1222]

I agree. This is a super useful feature that is not documented anywhere. I didn't want to have to define multiple interceptors throughout my angular application so I wrote a little angular wrapper like this:

class AngularSwaggerHttpClient {
  constructor($http) {
    this.type = 'AngularHttpClient';
    this.http = $http;
  }

  execute(obj) {
    obj.deferred = {
      promise: this.http({
        url: obj.url,
        method: obj.method,
        data: obj.body,
        params: obj.params,
        headers: obj.headers
      })
    }
  }
}

And then I create an angular factory with the following:

class HttpClient {
  static SwaggerClient($http) {
    'ngInject';
    return new SwaggerClient({
      spec: swaggerJson,
      client: new AngularSwaggerHttpClient($http)
    });
  }
}

One little caveat is that the above code relies on #728 because as you can see it is creating the SwaggerClient synchronously based on the provided spec.

[mbana]

Thanks, my vote is for this library: https://github.com/github/fetch.

[nucleardreamer]

@briananderson1222 do you have any current examples of this on github?

[briananderson1222]

@nucleardreamer not publicly :) but I have implemented it on an Ionic application and an Angular web app with no issues.

[shamas]

How do parameters on the execute function work?
Is execute with parameters the exact same as using the tag interface execute?
What happens if we pass multiple objects to the tag interface execute function?
How are we meant to override headers using the execute interface?

[xunxky]

actually WHERE is the documentation? it lacks documentation completely!

[char0n]

Created first PR that should increase the documentation coverage and quality of our documentation. I've started with a Swagger specification resolver.