Download the PHP package avalanche-development/swagger-router-middleware without Composer
On this page you can find all versions of the php package avalanche-development/swagger-router-middleware. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package swagger-router-middleware
swagger-router-middleware
PHP middleware that parses and attaches swagger information to a request object.
Installation
It's recommended that you use Composer to install swagger-router-middleware.
swagger-router-middleware requires PHP 5.6 or newer.
Usage
This middleware is instantiated with swagger (in the form of an array) and then, when invoked as middleware, will walk through the swagger document and parse things out. Specifically, it will pull out the path and operation, resolve parameters and security definitions, and parse out parameters based on the swagger definition.
It is recommended that this is one of the top items in the stack, as the swagger information that is parsed out can be used for request/response validation deeper in.
Interface
Once everything passes through successfully, the $request object will have the following attribute passed on.
An important note is that each parameter in the list will include a 'value' key that, if the parameter was passed into the request (or has a default), will be populated.
Documentation Route
If the standard 'documentation route' is detected (path of /api-docs), the rest of the stack is immediately skipped and the swagger spec is returned as json. An error with json_encode will throw a standard \Exception.
Invalid Requests
There is some routing being done here. If the request route cannot be found in swagger, or if the method is not supported, appropriate peel exceptions are thrown. Also, if there is an error with parameter parsing that appears to be an issue with request, a peel BadRequest is thrown. An error handler can listen for these HttpErrorInterface exceptions and respond appropriately.
Parameter Parsing
The middleware will do it's best to parse out the parameters for the request without too much validation. It loops through the swagger definition, looking for the parameters that are applicable for the route, and pull them from header/query/path/etc.
Again, this middleware will not check the existence, validity, or type of parameters based on the spec. It only tries to pull and expects something else in the stack to verify integrity.
Development
This library is still being developed and some bugs may be experienced. Feel free to add issues or submit pull requests when road bumps are noticed.
Tests
To execute the test suite, you'll need phpunit (and to install package with dev dependencies).
License
swagger-router-middleware is licensed under the MIT license. See License File for more information.
All versions of swagger-router-middleware with dependencies
psr/http-message Version ^1.0
psr/log Version ^1.0
avalanche-development/peel Version ^0.3