Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

--default-base-path vs --url #145

Closed
p4ul opened this issue May 25, 2014 · 1 comment
Closed

--default-base-path vs --url #145

p4ul opened this issue May 25, 2014 · 1 comment

Comments

@p4ul
Copy link

p4ul commented May 25, 2014

Hi,

What is the difference between these two cli options?

I was using --default-base-path before the last update to set the base url for my API requests. That no longer works and I have switched to --url

Reading the CLI output I think default-base-path should be removed? or is there something I am missing?

  -o, --output        Directory to store the generated json documents.
  -u, --url           Url to the output folder. (api-docs basePath)
  -e, --exclude       Exclude path(s).
                         ex: --exclude vendor:library/Zend:library/Foo
  -b, --bootstrap     Bootstrap php file(s) for defining constants, etc.
                         ex: --bootstrap autoload.php:config/contants.php

  --default-base-path        Provide a default basePath for the resources
  --default-api-version      Provide a default apiVersion for the resources
  --default-swagger-version  Provide a default swaggerVersion for the resources
  --api-doc-template         Provide a json template for the resource listing

  -v, --version       Swagger-PHP version
  -h, --help          This help message
@bfanger
Copy link
Collaborator

bfanger commented May 28, 2014

--url is for the location of the api documentation (the files swagger-php generates)
--default-base-path is for the api (your app / rest interface)

Both use the "basePath" name in the swagger spec, which is confusing. I accidentally used
--url instead of the correct --default-base-path in 0.9.3.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants