TOC.md

Table of Contents

Introduction

• Installation
• Getting Started
• REST Service Tutorial
• Updating to version 1.4

API Primer

• What is an API?
• Representation Formats
• Hypermedia Application Layer
• Error Reporting
• HTTP Method Negotiation
• Content Negotiation
• Content Validation
• Versioning

Authentication and Authorization

• Introduction
• About Authentication
• HTTP Basic Authentication
• HTTP Digest Authentication
• OAuth2 Authentication
• Authorization
• Advanced Auth Events and Services
• User Differentiation

Content Validation

• Introduction
• Basic Usage
• Filtering
• Validating
• Advanced Content Validation

API Documentation

• Introduction
• Swagger format
• Customize API documentation

Deployment

• Deploying API Tools

Recipes

• Adding API Tools to an Existing Project
• Customising Authorization for Specific Identities
• Returning HAL from RPC Services
• Customizing DB-Connected TableGateways with Features
• Upload Files Via Your API
• Allowing requests from other domains
• Use URL Parameters to Filter or Sort Data
• Using Social Authentication for your API
• Providing REST endpoints that JOIN table data

Module Reference

• api-tools
• api-tools-admin
• api-tools-api-problem
• api-tools-asset-manager
• api-tools-configuration
• api-tools-content-negotiation
• api-tools-content-validation
• api-tools-doctrine
• api-tools-doctrine-querybuilder
• api-tools-documentation
• api-tools-documentation-apiblueprint
• api-tools-documentation-swagger
• api-tools-hal
• api-tools-http-cache
• api-tools-mvc-auth
• api-tools-oauth2
• api-tools-provider
• api-tools-rest
• api-tools-rpc
• api-tools-versioning
• api-tools-welcome
• zf-console
• zf-deploy