Download the PHP package elastic/openapi-codegen without Composer

On this page you can find all versions of the php package elastic/openapi-codegen. 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?

Informations about the package openapi-codegen

Elastic OpenAPI PHP client generator.

CircleCI build

Make easier clients creation by generating most of the code from an Open API specification.

Projects using the Elastic OpenAPI PHP client generator:

Contents


Getting started with the generator 🐣

Requirements

We assume you have the following components installed and available in your environment :

  • Docker (used to run the code generator)
  • composer

Initiliaze project

When you want to create a new client you have first to create a new composer project :

Once the project is created you should pimp up your composer.json file (package name, author, ...). Make sure the autoload section contains the PHP namespace you want to use for your client (here Fancy\Client):

Once the project is created , you have to append the code generator as a requirement of the project:

Configuring the generator

By convention, the code generator expect the resources/api folder containing two files :

Running the generator

Once the project is setup and the generator is configured, you can run code generation by using the launcher script from the root of your project :

The generator will create or update the following files in your project :

Create the client builder

Client instantiation logic is very specific for each project and need to be customized for each project (authentication management, error handling). At the same time end users of your client expect a very easy to use method to instantiate the client.

Here is a code for providing a very basic client builder to end users:

Using the client

Once you will have fulfilled the tasks above, it is very simple for end user to get client they can use :

Customization

Now you have a working client, there is several things that you may want to customize :

You can find a full documentation of available extension point in the Customization documentation.

FAQ 🔮

Where do I report issues with the client?

If something is not working as expected, please open an issue.

Contribute 🚀

We welcome contributors to the project. Before you begin, a couple notes...

License 📗

Apache 2.0 © Elastic

Thank you to all the contributors!


All versions of openapi-codegen with dependencies

PHP Build Version
Package Version
Requires php Version ^5.6|^7.0|^8.0
guzzlehttp/ringphp Version ^1.0
psr/log Version ^1|^2|^3
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 elastic/openapi-codegen contains the following files

Loading the files please wait ....