yiisoft / yii-swagger Goto Github PK

What steps will reproduce the problem?

4

What is the expected result?

I don't know if step 4 in wich file paste this code. I supose that the file is /project/config/web.php, but when i put the code fail, the error say "Uncaught Error: Class "Yiisoft\Definitions\Reference"."
Please help me.

Another question is, if i have in config/web.php

'urlManager' => [
            'enablePrettyUrl' => true,
            'showScriptName' => false,
            'rules' => [
                    '<controller:\w+>/<id:\d+>'=>'<controller>/view',
               '<controller:\w+>/<action:\w+>/<id:\d+>'=>'<controller>/<action>',
               '<controller:\w+>/<action:\w+>'=>'<controller>/<action>'
            ],

where is the route to see swagger ui.
Thanks a lot for the support.

What do you get instead?

Additional info

Readme is missing info about Yiisoft\Swagger\Service\SwaggerService.

https://github.com/yiisoft/docs/blob/master/004-namespaces.md

Steps to reproduce:

• Create any route with swagger declaration
• Add Locale middleware from yii-middleware package
• Open swagger

What I expect to see:
All routes should contain the path part from Locale middleware: {_language} with an ability to change it on request

What I see:
All routes are exactly as they were declared

Looks like the problem is larger than it is. Having swagger declaration in third-party library developer may have wrong addresses that make our swagger package unusable. Just think of that you're changing /debug route from yii-debug package to /infra/debug and you still have /debug into your swagger panel, do not have /infra/debug and any /debug calls bring errors.

@yiisoft/yii3 do you have any thought about it?

Annotations are very frustrating to use. The IDE has poor support for it and is difficult to debug.
Suggest using the new PHP feature attributes，like https://github.com/uderline/openapi-php-attributes

See Swagger-PHP documentation for details on how to annotate your code.