Download the PHP package mvaliolahi/sibdoc without Composer

On this page you can find all versions of the php package mvaliolahi/sibdoc. 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 mvaliolahi/sibdoc

Informations about the package sibdoc

SibDoc

Latest Stable Version Total Downloads Build Status PHP-Eye PHPStan

Generate API Document Using Pure PHP.

#### Install #### 1. Instantiate SibDoc. To generate document for your awesome API create an instance of SibDoc: - Tip: There is another optional argument called `'background_color => '#0099cc'` to specify Document background color. #### 2. Define Endpoints Tips: - Request can have more than one response, just define another Response object and assign it to `$request`. - $request->response('Success', $success); is another way to assign response to request and define alias for response. - Request and Response they both have `description()` method, this method is optional. - You can define Header for both Request and Response Objects using `headers()` method for example: `$request->headers([])`. or define a general header for those using `$api->requestHeaders([])` or `$api->responseHeaders([])` method.

Available methods: - get - post - put - patch - delete - head - connect - options - trace ###### Define Group #### Define Model ##### Use model as part of response body #### 3. Generate Html By default SibDoc can generate a file called `document.html` for you. Tips: - first argument specify export path, after call `saveTo()` method with related parameters, it will generate a file called `document.html` in that path. - second argument refer to built-in Generator for create html file. - you can define your custom generator to create you desire format, for example `markdown` or maybe `json` file. i will demonstrate to you right below! ##### Create Custom Generator first of all you need a regular class and you should extends it from `DocumentGenerator` abstract class. There are several method after extends your class that you can use to generate your custom format. - groups() * gives you all defined groups. when group name is not string that's mean its not a group, means its a single endpoint. - endpoints() * gives you an array contains all endpoints and group, each group can have several endpoint. - models() - backgroundColor() * gives you the `background_color` value from what you pass as SibDoc instance argument. it up to you how use them and how is your final format. at the end you should pass your generator as argument to SibDoc:

All versions of sibdoc with dependencies

PHP Build Version
Package Version
Requires twig/twig Version ^2.0
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 mvaliolahi/sibdoc contains the following files

Loading the files please wait ....