Download the PHP package sakadigital/api without Composer
On this page you can find all versions of the php package sakadigital/api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sakadigital/api
More information about sakadigital/api
Files in sakadigital/api
Package api
Short Description Package for build Rest Api for your application
License MIT
FAQ
Example:
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 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.
Informations about the package api
Rest Api Structure for Laravel
Build Rest Api with laravel Php Framework. This package also genrate automaticly documentation for your API based Api controller docblock and test api function.
Features
- Versioning API
- Enabled/Disabled API or Some version
- Enabled/Disabed Documentation
- Bypass csrf token laravel for api prefix
- Auto-generation of API documentation based on docblock
- Simulate API call & view API return data
Installation
Require this package with composer:
After updating composer, add the ApiServiceProvider to the providers array in config/app.php
and also add the facades
Copy the package resource to your application with the publish command:
by run command vendor:publish we will copy folder and file as following:
- Config file
api.phpto/configfolder - Asset folder
apidocto/publicfolder, this folder contain css,js, etc. - Api structur
Apifolder to/App, this folder containControllersfolder as a place for your api controller, androutes.phpfor api route.
And you are ready to build your API.
Using The Package
If you finish installation process above, by default your api is active and now you can checkout your api by GET http://yourdomain.com/api, and also documentation by GET http://yourdomain.com/api/doc.
creating controller
Your controller is your documentation, so we sugest you to follow some our standard to make controller file for documentation page.
Class Name
- use prefix and suffix for contoller
Api{{Object}}Controller, for example if you will use Auth you should use file and class nameApiAuthContoller, - Add description to your calss.
Function
each function must have a description, param, return, and error. example:
in @param contain information about paramter, description and validation rule that sparated by |, and in @return also contain return type or name and description of function return. @error is special error that function made, you can give the information to the error.
- Place your all controllers inside Api controllers folder.
using versioning
if you will make your api with many version create folder inside you api namespace :
place your routes.php in each version and create Controllers folder in each version and place your contorller and register your api version bellow as following:
your version prefix will placed in second url prefix http://yourdomain.com/{api-prefix}/{version-prefix}/
Routing
this package will automaticly append prefix to routes as api config file
test by GET http://yourdomian.com/api/`test', if you use version v1, GET http://yourdoumain/api/v1/test
