HiveApi
latest
Getting Started
Software Requirements
Installation
Overview
Architecture Pattern
Requests
Responses
Conventions and Principles
Core Components
Actions
Configuration Files
Controllers
Migration Files
Models
Repositories
Routes
SubActions
Tasks
Transformers
Transporters
Views
Optional Components
Commands
Criteria
Events
Exceptions
Exception Formatters
Factories
Jobs
Languages
Mails
Middlewares
Notifications
Service Providers
Requests
Seeders
Values
Features
Authentication
Authorization
Caching
Default Endpoints
ETags
Generators
Hash IDs
Localization
Pagination
Profiler
Query Parameters: Search
Rate Limiting (API Throttling)
Request Monitor
System Settings
Validation
Versioning
Misc
Magical Call
Task Queuing
Task Scheduling
Useful Commands
HiveApi
Docs
»
HiveApi
Edit on GitHub
HiveApi
ΒΆ
Getting Started
Software Requirements
Installation
HiveApi Application Installation
B) Development Environment Setup
C) Play
Overview
Quickstart
Architecture Pattern
Porto
MVC
Requests
Form Content Types (W3C)
HTTP Request Headers
Calling Endpoints
Responses
Paginated Response:
Including Resources
Change the default Response payload:
Resource Keys
Error Responses Formats
Building a Responses from the Controller
Conventions and Principles
HTTP Methods usage in RESTful APIs
Naming Conventions for Routes & Actions
General Guidelines and Principles for RESTful URLs
Core Components
Actions
Rules
Folder Structure
Code Sample
Examples
Configuration Files
Principles
Rules
Folder Structure
Code Samples
Controllers
Rules
Folder Structure
Code Sample
Controller Response Builder Helper Functions
Migration Files
Rules
Structure
Code Samples
Models
Rules
Folder Structure
Code Sample
Casts
Repositories
Principles
Rules
Folder Structure
Code Samples
Routes
Rules
Folder Structure
Web Routes
Protecting Endpoints:
SubActions
Rules
Folder Structure
Code Sample
Tasks
Rules
Folder Structure
Code Sample
Transformers
Rules
Folder Structure
Code Samples
Relationships (Includes)
Helper Functions for Transformers
Transporters
Rules
Folder Structure
Code Sample
Automatically Transforming a Request to a Transporter
Data Access
Instance Access
Views
Rules
Folder Structure
Code Sample
Namespaces
Optional Components
Commands
Principles
Rules
Folder Structure
Code Samples
Define Consoles Routes
Criteria
Principles
Rules
Folder Structure
Code Samples
Events
Principles
Enabling Events
Usage
Exceptions
Principles
Rules
Folder Structure
Code Samples
Usage
Application Error Codes
Exception Formatters
Rules
Folder Structure
Code Sample
Creating Your Own Formatter
Factories
Rules
Folder Structure
Code Samples
Jobs
Rules
Folder Structure
Code Samples
Languages
Rules
Folder Structure
Usage
Mails
Principles
Rules
Folder Structure
Code Samples
Email Templates
Configure Emails
Queueing Notifications for Later Use
Middlewares
Principles
Rules
Folder Structure
Code Sample
Notifications
Principles
Rules
Folder Structure
Code Samples
Select Channels
Queueing a Notification
Use Database Channel
Service Providers
Principles
Rules
Folder Structure
Code Samples
Register Service Providers
Laravel 5.5 Auto Discovery feature.
Information about Laravel Service Providers
Requests
Rules
Folder Structure
Code Samples
Using Requests in the Contorller
Request Properties
How the Authorize Function Works
Allow a Role to access every endpoint
Request Helper Functions
Storing Data on the Request
Seeders
Principles
Rules
Folder Structure
Code Samples
Running the Seeders
HiveApi Seeder Commands
Values
Rules
Folder Structure
Code Sample
Features
Authentication
API Authentication (with OAuth 2.0)
Web Authentication
Refresh Token
Force Email Confirmation
Authorization
Usage
Example
Responses
Seeding Users
Roles & Permissions guards
Permissions Inheriting with Levels
Caching
Enable / Disable Eloquent Query Caching
Change Different Caching Settings
Default Endpoints
ETags
Generators
Available Code Generator Commands
Custom Code Stubs (aka. Customizing the Generator)
Hash IDs
Enable Hash ID
Example:
Usage
Configuration
Testing
Availability
Localization
Select Request Language
Support New Languages
Translating Strings
Disable the Localization Feature
Get Available Localizations
Tests
Pagination
Change the Default Pagination Limit
Limit
Usage
Skip the Pagination Limit
Profiler
Sample Profiler Response
Configuration
Query Parameters: Search
Rate Limiting (API Throttling)
Enable/Disable Rate Limiting:
Request Monitor
Enable Requests Logging
Usage
Change the Default Log File
System Settings
Seed Default Settings
Read Settings
Validation
Request
Responses
Versioning
Usage
Version the API in Header instead of URL
Misc
Magical Call
Usage
Transactional Magical Call
Use Case Example
Task Queuing
Beanstalkd
Task Scheduling
Setup Server
Setup and Configure your Application
Useful Commands
Available Commands (Excerpt)
List All Actions / Tasks Command
List Container Dependencies Command
Read the Docs
v: latest
Versions
latest
Downloads
pdf
htmlzip
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.