API passthrough to real API

[swagger-api]

API passthrough to real API

[fehguy]

I believe you can add routes directly to the express object:

https://github.com/wordnik/swagger-node-express/blob/master/Apps/petstore/main.js#L25

Wouldn't that do it? Swagger won't even know about the routes.

[joseairosa]

Possibly. I need to read more about express, still fairly new.

Any chance you could point me into the right direction?

Lets use this example. I've got the following API endpoint, https://api.com/resource/blergh and I want to document it so that when the user clicks on "Try me" it goes directly to the API and not swagger.

Thanks!

[fehguy]

OK, I misread your request then--what you really want is to generate documentation manually, and still have the node server process it?

If that's the case, you can easily just write the JSON by hand, and have express display the json as static docs. Look here for an example:

https://github.com/wordnik/swagger-core/tree/master/samples/no-server

[joseairosa]

Yes that's correct.

I'd have something like https://docs.api.com/ which is where swagger would be and, instead of querying localhost, it would query directly the api that is on https://api.com/

From what I understand I'd have to change api-docs.json to something like:

{
  "apiVersion":"0.2",
  "swaggerVersion":"1.1",
  "basePath":"https://api.com",
  "apis":[
    {
      "path":"/resource/blergh",
      "description":"Operations about store"
    }
  ]
}

[joseairosa]

Actually, no, I think I understand now. I'd have to keep this file as:

{
  "apiVersion":"0.2",
  "swaggerVersion":"1.1",
  "basePath":"https://docs.api.com",
  "apis":[
    {
      "path":"/api-docs/resource",
      "description":"Operations about resource"
    }
  ]
}

And then create a file in /api-docs named resource.

Inside this file I'd have:

{
  "apiVersion":"0.2",
  "swaggerVersion":"1.1",
  "basePath":"https://api.com",
  "resourcePath":"/resource",
  "apis":[
    {
      "path":"/blergh",
      "description":"Operations about pets"
    }
  ]
}

Correct?

[joseairosa]

So I've got it more or less working.

I did the changes above and still using node.js to have as my standalone server.

The problem is that all my requests to the real API are coming out as OPTIONS instead of GET.

I've clearly set them as GET in my json description file. Any clues?

[fehguy]

You do need to support OPTIONS requests to the resource files, which are the resource listing (i.e. http://petstore.swagger.wordnik.com/api/api-docs.json) and the api declarations (such as http://petstore.swagger.wordnik.com/api/api-docs.json/pet)

If you're manually generating the files, take a look at those files as examples (in fact, just clone them for your test) and the wiki which defines their structure:

https://github.com/wordnik/swagger-core/wiki/Resource-Listing

[joseairosa]

Hi @fehguy,

Lets assume that the UI is running on http://localhost and the real api is running on https://api.com

Both requests for the resource listing work with no problems. The one that doesn't work the actual request to the API.

So, in short, it shows my documents GET endpoint on the UI (http://localhost). I click on it to show the description and the "Try me" button. When I press it all data is sent to https://api.com but instead of being sent as GET it's being sent as OPTIONS.

Check the image attached.

Thanks

[joseairosa]

Any update on this?

[fehguy]

Hi, sorry for the delay, with the 1.2 spec getting released I probably won't be able to get to this for a bit.

[fehguy]

the 1.2 spec version is pushed, and you should give that a shot.