Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 1.02 KB

hal.md

File metadata and controls

43 lines (31 loc) · 1.02 KB
id title header_title header_icon breadcrumbs nav
page-plugin
Plugins - HAL
HAL
/assets/images/icons/plugins/hal.png
Plugins
/plugins
label
Getting Started
label items
Usage
label
Terminology
label
Configuration

The HAL plugin rewrites currie-values from hal/json bodies.


Terminology

  • API: your upstream service, for which Kong proxies requests to.
  • Plugin: a plugin executes actions inside Kong during the request/response lifecycle.

Configuration

Configuring the plugin is straightforward, you can add it on top of an [API][api-object] by executing the following request on your Kong server:

$ curl -X POST http://kong:8001/apis/{api}/plugins \
--data "name=hal"

api: The id or name of the API that this plugin configuration will target

form parameter required description
name required The name of the plugin to use, in this case: hal