Question: More than one api-docs.json? about swagger-docs HOT 8 CLOSED

Could you provide a bit more detail/overview of how the APIs currently fit together and what the end state goal is - perhaps a high level example would be good. Would there be any overlap between the different outputted api-docs files or would the APIs be unique in each file?

from swagger-docs.

We currently develop an application with different API consumers:

• The client apps (iPhone, Android, a javascript web app). We only create the backend and the API consuming programs are written by other companies
• Data brokers. This app gets input from other companies. They push and pull data in and out of the app.

We don't want the client app devs to see that there is a different api and prevent that they use those APIs accidently.

Currently the api scheme is.

• myapp.com/api/client/v1/ ....
• myapp.com/api/broker/v1/ ....

Both paths should have a separate api documentation as swagger json files.

I totally understand that this might be out of scope of this gem.

from swagger-docs.

As they are separate, an initializer with both APIs should work I think (not tested):

Swagger::Docs::Config.register_apis({
"1.0-client" => {:controller_base_path => "api/v1/client", :api_file_path => "public/api/client/v1/"},
"1.0-broker" => {:controller_base_path => "api/v1/broker", :api_file_path => "public/api/broker/v1/"}
})

from swagger-docs.

Ah, great. I will try to do that on monday!

from swagger-docs.

@bitboxer How did you get on?

from swagger-docs.

It's not working. Will have to debug it what actually went wrong. Hopefully i have time for this till the end of the week.

from swagger-docs.

Sorry for the delay. It's working. Thanks!

from swagger-docs.

Excellent! Glad you got it going.

from swagger-docs.