Download the PHP package jheckdoc/jheckdoc-laravel without Composer

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

Informations about the package jheckdoc-laravel

JheckDoc Laravel logo

Jheckdoc laravel

MIT License

Simple laravel api document generator



Dashboard preview

Demo page:

https://jheckdoc-laravel-demo.herokuapp.com/api/documentation

Installation

You can install the package via composer

Usage

Generate json file

Publish config files

Parameters

Name Type Description
@jheckdocInfo String TThis is required for details of api documentation. Sample header
@jheckdoc String This is required to add on top of each codeblocks. Sample annotation
method String Your desired route method, Sample GET, POST, PUT, DELETE, OPTIONS
route String Your api endpoint. Note: no need to put the full url
name String Enter desired name for your endpoint
description String Description of your endpoint
headers Object For custom headers
params Object Enter parameters for your endpoint
responses Object Server responses

Api documentation detail information (required)

Sample annotation

Each code block requires a valid json format. Please see Sample annotations for more.

View api docs (default)

http://localhost:8000/api/documentation

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, pelase use issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

Copyright (c) 2020, Jeric

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.

All versions of jheckdoc-laravel with dependencies

PHP Build Version
Package Version
Requires php Version ^7.1
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 jheckdoc/jheckdoc-laravel contains the following files

Loading the files please wait ....