New manifest for NelmioApiDocBundle version 3 #207
Conversation
ghost
deployed
to
| # licenseUrl: null | ||
| # cache: | ||
| # enabled: false | ||
| # file: '%kernel.cache_dir%/api-doc.cache' |
There was a problem hiding this comment.
Should be replaced by something like:
nelmio_api_doc:
documentation:
info:
title: My App
description: This is an awesome app!
version: 1.0.0
routes: # to filter documented routes
path_patterns: # an array of regexps
- ^/api
- ^/api/doc$
There was a problem hiding this comment.
IMO the default /api/doc route should be excluded from the swagger by defining the path_patterns in a format, something like - ^/api/(?!doc) because currently, it will display /api/doc route in the swagger which is un-needed.
There was a problem hiding this comment.
@takeit you're right, I updated my message
| @@ -0,0 +1,3 @@ | |||
| NelmioApiDocBundle: | |||
| resource: "@NelmioApiDocBundle/Resources/config/routing/swaggerui.xml" | |||
| prefix: /api/doc | |||
There was a problem hiding this comment.
I guess this should be commented and we should mention that it requires the asset component and the twig bundle.
|
Thank you for this PR. Im not a big fan of having all the config as a comment. We should add some good default config or remove the file completely. In fact, that config you provide, isn't that good for 90% of the use cases already? |
|
Well we can indeed uncomment it if you prefer :) |
|
I think it looks like we can do that. But you know far much more of this bundle than I do. So I direct the decision back to you: Do you think that configuration will be a good start for 90% of the users? Could you make it so? |
I think it is, it's even what we show first in the bundle's readme. |
|
Then go for it =) Remove those comments |
There was a problem hiding this comment.
thanks for working on this, lets wrap it up. can you please check which of the settings are the default value anyways? afaik best practice for the recipes is to not provide configuration with default values that are not likely to be changed. those that are likely to be changed can be in to give a hint. but in the end users are still expected to look at the documentation if they want to customize with configuration. (also, once installed, this file is not updated anymore in users project, so an exhaustive documentation in the recipe files would be counterproductive, as updates will not be seen by users.
| # api_version: '0.1' | ||
| # info: | ||
| # title: Symfony2 | ||
| # description: 'My awesome Symfony2 app!' |
There was a problem hiding this comment.
flex is symfony 4 mostly, we should just say Symfony instead of Symfony2
| # enabled: true | ||
| # parameter: _doc | ||
| # swagger: | ||
| # api_base_path: /api |
There was a problem hiding this comment.
when we uncomment, i guess this should have a comment line above to say what this is.
There was a problem hiding this comment.
This is 2.0 actually, it does no longer exist in 3.0 :)
|
Good day, people, |
|
I’m waiting on the author to complete the pr. It seams like there was some suggested changes. |
|
Okay. Thanks. |
|
@Nyholm It may be better to send a new pull request? Since the author is inactive. |
|
See #226 |
Fixes #197