Download the PHP package osushi/apidoc without Composer
On this page you can find all versions of the php package osushi/apidoc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download osushi/apidoc
More information about osushi/apidoc
Files in osushi/apidoc
Download osushi/apidoc
More information about osushi/apidoc
Files in osushi/apidoc
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:
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.
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 apidoc
apidoc
Generate markdown documentation from your code.
Requirements
php>=7.2.5 || ~8.0.0
Installation
Usage examples
Script
1. Create script file
2. Edit code
3. Run apidoc
Here are examples
- toc.md
- users.md
:warning: If you want to render documents, please run script with APIDOC params.
Integration to phpunit
1. Initialize apidoc on bootstrap.php
2. Write your feature test.
3. Run apidoc
Documents
Initialization
Configuration
- Config::DOCUMENT_TEMPLATE_PATH - [String] twig template for each document (default: document.md)
- Config::DOCUMENT_TOC_TEMPLATE_PATH - [String] twig template for ToC of docuement (default: document.toc.md)
- Config::DOCUMENT_TOC_TITLE - [String] ToC of document title (default: # Table of Contents)
- Config::TOC_TEMPLATE_PATH - [String] twig template for ToC (default: toc.md)
- Config::TOC_TITLE - [String] ToC title (default: # Table of Contents);
- Config::OUTPUT_PATH - [String] location to output files (default: ./docs);
- Config::TOC - [Boolean] whether to generate toc.md (default: true);
Parameter
- add(string $value, array $options) - Add parameters for documents
- options.isa - string (e.g. string, integer)
- options.required - boolean (e.g. true/false)
- options.comment- string (e.g. comment)
- options.format- string (e.g. Ymd)
- options.except - array (e.g. ['bob', 'john'])
- options.only - array (e.g. [10, 20])
- note(string $node) - Add note for documents
Request
Response
License
MIT
All versions of apidoc with dependencies
PHP Build Version
Package Version
The package osushi/apidoc contains the following files
Loading the files please wait ....