Coder Social home page Coder Social logo

nostop8 / yii2-rest-api-doc Goto Github PK

View Code? Open in Web Editor NEW
21.0 21.0 15.0 29 KB

Simple documentation generator for Yii2 REST applications based on defined API endpoints and actions annotations.

License: MIT License

PHP 79.29% CSS 0.70% JavaScript 20.01%

yii2-rest-api-doc's People

Contributors

mariodro avatar nostop8 avatar padlyuck avatar wardley avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

yii2-rest-api-doc's Issues

Запуск yii2-rest-api-doc

Установил через компосер -> прописал в конфиге все по инструкции
перехожу на страницу site.name/documentation, получаю вот что: link
как двигаться дальше не пойму.

request method OPTIONS not supported?

PHP Notice – yii\base\ErrorException
Undefined index: OPTIONS

            [
                'class'         => 'yii\rest\UrlRule',
                'controller'    => 'nameController',
                'extraPatterns' => [
                    'GET total'           => 'total',
                    'OPTIONS total'       => 'options'
                ],
            ],

Panels don't stay open.

Hi everybody,

thanks for creating this tool, it's quite helpful.

Sadly I'm running into a bug that's really stopping me from using the application right now: Every time I click on one of the generated panels, the contents are visible for a split second and then get closed again.

I investigated this behaviour a bit and it seems like the css selector .collapse:not(.show) that got added from another bootstrap package is to blame.

I would be really grateful for any hints on how to resolve this conflict.

What version of jQuery and Bootstrap.css/js is required?

Can you please tell me what versions of Bootstrap and jQuery you require? The Bootstrapplugin is not required in your composerand I don't know what version you used, I tried 4.x and 3.x and Bootstrap 3.x seems to work, but I always receive a JS error when clicking on an item

Uncaught Error: Syntax error, unrecognized expression: #xxxx

It looks like this currently
image

Collapsed API boxes don't open for controllers in modules

If you are using a controller that is inside of a module like this:

        'urlManager' => [
            'enablePrettyUrl' => true,
            'showScriptName' => false,
            'rules' => [
                [
                    'class' => 'yii\rest\UrlRule',
                    'controller' => ['markets' => 'dynamic-pricing/market'],
                    'prefix' => '/api/',
                    'only' => [
                        'GET /' => 'index',
                    ]
                ]   
            ],
        ],

You will receive this console error when trying to open the collapsed API box:
Uncaught Error: Syntax error, unrecognized expression: #Dynamic-pricing/market

It seems to be from there being a slash in the anchor link. Should we just replace these forward slashes with dashes? I tried that locally and it seems to fix the issue. The only problem is that I'm stuck with a title like "Dynamic-pricing-market" in the header.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.