mashery / iodocs

Interactive API documentation system
MIT License
1.89k stars 415 forks source link

Implemented parameterized base url. #220

Open pkandathil opened 9 years ago

pkandathil commented 9 years ago

Our team codes on servers and we have separated the workspaces by subdomain. http://{username}.domain.com. Having parameters in the baseurl greatly helps with being able to call services deployed to each user's environment.

phairow commented 9 years ago

Hi @pkandathil This looks like a great addition. Would you be able to include example definitions that leverage this functionality. We should also update the readme to illustrate the enhancement. I am looking at another pull request which adds tests so once that's in I can use the sample definitions to create tests for this addition. I also want to dig a little deeper on the UI change (hidden elements), it looks like you are handling the basePath, privatePath and methodPath and it's missing publicPath. Am I missing something, is publicPath covered already, or should we consider that one too?

pkandathil commented 9 years ago

Hi @phairow You are correct. I should add public path too. I missed that. I will make the change. I can add another example. I think it should be under the "API-LEVEL CONFIG DETAILS" section. Let me know if that is wrong. Regarding sample services. I haven't added as on my last pull request you asked me not to check in any of personal tests. Let me know if there is anything else you need.

phairow commented 9 years ago

That's awesome. Yeah, we shouldn't add the definitions to the main list but just send a sample in the comments here or document the functionality in the readme or something. We will get more formal on testing and documentation going forward.

pkandathil commented 9 years ago

@phairow I updated the docs.

phairow commented 9 years ago

Thanks @pkandathil will review this as soon as possible.

 On Monday, October 27, 2014 11:37 PM, pkandathil <notifications@github.com> wrote:

@phairow I updated the docs.— Reply to this email directly or view it on GitHub.