Download the PHP package ybelenko/oauth2_as_oas3_components without Composer

On this page you can find all versions of the php package ybelenko/oauth2_as_oas3_components. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of ybelenko/oauth2_as_oas3_components

Informations about the package oauth2_as_oas3_components

OAuth2 as OpenAPI Spec 3.0 components

The example file which describes OAuth2 token endpoints located dist/oauth2_endpoints.yml.

Why this package exists

Since RFC 6749 OAuth2 server implementation may be very different(optional/recommended response fields, extended grant) it might me useful to describe your unique implementation within your OAS3 file. It's also very handy to see examples of your token and error response, because RFC6749 is a text document without any pictures or graphs. The example file mentioned before contains description of token endpoints for each authorization grant, consider it as starting point.

Example file omits authorization endpoint endpoint on purpose. I don't know how to describe it with OAS3 since endpoint response isn't JSON(html page). If you have any suggestion please submit an issue to this repo.

Since RFC 6749 - The OAuth2.0 Authorization Framework - 2.3.1. Client Password doesn't recommend to send client password in request body then our example expects basic authorization in all endpoints.

Installation

Copy Paste

Since it's not actually a code, but markup you can just copy anything you want from dist/oauth2_endpoints.yml.

There is also enhanced example with polymorphism at dist/oauth2_endpoints_polymorphism.yml. Please, make sure that your tools supports polymorphism. This example contains new features not highly adopted yet. Check at least oneOf property support. I wouldn't use it myself because most of the OpenAPI tools have issues with polymorphism now, but this example may be useful in forseeable future.

Composer

Install Composer - Dependency Manager for PHP

Then run in terminal:

Use provided components via $ref attribute like:

Extended example with refs dist/oauth2_endpoints_with_refs.yml

NPM

Install NPM and Node.js

Then run in terminal:

Use provided components via $ref attribute like:

Extended example with refs dist/oauth2_endpoints_with_refs.yml

Contributing

If you have any suggestions please submit an issue.

License

MIT License

All versions of oauth2_as_oas3_components with dependencies

PHP Build Version
Package Version
No informations.
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package ybelenko/oauth2_as_oas3_components contains the following files

Loading the files please wait ....