https://github.com/muhammadn/firetail-apisix-go-plugin

https://github.com/muhammadn/firetail-apisix-go-plugin

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/muhammadn/firetail-apisix-go-plugin
• Owner: muhammadn
• License: lgpl-3.0
• Created: 2024-02-02T18:55:04.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-07-01T13:30:39.000Z (7 months ago)
• Last Synced: 2024-11-17T22:08:36.152Z (2 months ago)
• Language: Go
• Size: 12.7 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
### Building

In the root directory, run `make build`

### Running in development mode

In the root directory, run the unix socket with `APISIX_LISTEN_ADDRESS=unix:/tmp/runner.sock APISIX_CONF_EXPIRE_TIME=3600 ./go-runner run`

Then in apisix's configuration file `config.yaml` add this:

```

ext-plugin:

  path_for_test: /tmp/runner.sock

```

and restart apisix `apisix restart`

### Testing

#### Enable both firetail request and response filtering via apisix API:

**NOTE** You will need to run your application at localhost (127.0.0.1) port 1980. If you wish to point it elsewhere, change the "nodes" parameter from example below.

 

```

curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '

{

  "uri": "/profile/alice/comment",

  "plugins": {

    "ext-plugin-pre-req": {

      "conf": [

        {"name":"firetail", "value":"{\"body\":\"\"}"}         

      ]

    },

    "ext-plugin-post-resp": {

      "conf": [

        {"name":"firetail", "value":"{\"body\":\"\"}"}      

      ]

    }

  },

  "upstream": {

    "type": "roundrobin",

      "nodes": {

        "127.0.0.1:1980": 1

    }

  }

}'

```