Download the PHP package delboy1978uk/bone-open-api without Composer

On this page you can find all versions of the php package delboy1978uk/bone-open-api. 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 delboy1978uk/bone-open-api

Informations about the package bone-open-api

openapi

OpenApi package for Bone Framework

installation

Use Composer

setup

Simply add to the config/packages.php

Create a config array entry/file. You can add a (client_credentials) client so the docs page can authorize and test your endpoints.

Run booty to deploy the front end assets.

If you do not have an npm project yet, you can simply run

which will create a package.json and typespec config file, as well as the spec folder and files for your API definitions, including definitions from vendor packages.

If you already have a pacakage.json, then your files will be left untouched. You should add the following to your package.json

Now you can run vendor/bin/bone docs:setup.

vendor package API definitions

Vendor packages can also provide API definitions. These are loaded in to the vendor.tsp files in the spec folder. These files are autogenerated and ashould not be edited.

To update the vendor definitions, run

compiling open api docs

To create the OpenApi definition file, we compile the docs using the following command (be it npm, pnpm, or yarn)

Now you can head to /api/docs to view your API documentation. 😃 Click on the Authorize button, your client ID and secret should already be populated, so click Authorize again, and you are ready to start calling your endpoints!

All versions of bone-open-api with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
boneframework/contracts Version ^1.6
delboy1978uk/bone-oauth2 Version ^1.9
laminas/laminas-diactoros Version ^3.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 delboy1978uk/bone-open-api contains the following files

Loading the files please wait ...