README.md

Documentation

Home

🚀 2 minute docs

Just the essentials

• Quick start
  End-to-end setup on one page

📗 5 minute docs

A bit more background...

• Quick start
  End-to-end setup on one page
• Tips and tricks
  The best bits of the library on one page
• Actions config
  All the ways to configure endpoints
• ApiGroup
  The primary class you'll use package and call endpoints

📚 20 minute docs

The whole enchilada!

• Getting started
  Start here to understand the package

  • Quick start
    End-to-end setup on one page
  • Tips and tricks
    The best bits of the library on one page
  • Actions config
    All the ways to configure endpoints

• Classes
  Core functionality packaged as classes

  • ApiCore
    Provides base functionality for all other classes
  • ApiGroup
    Extends ApiCore to package URLs as callable actions
  • ApiEndpoint
    Extends ApiGroup to manage CRUD endpoints
  • ApiResource
    Extends ApiEndpoint to more fully manage CRUD resources

• Extension
  Extend Axios Actions to encapsulate logic within services

  • Hooks
    Modify request and response data
  • Plugins
    A simple architecture to package hooks as functions
  • Helpers
    Helper functions to make modifying data a little easier
  • Classes
    Package all custom functionality into a new service template