# README

ngx

ngx is a Go client library for NGINX Plus API. The project was initially based on the fork of the open source NGINX Plus client API.

The library works against versions 4 to 8 of the NGINX Plus API. The table below shows the version of NGINX Plus where the API was first introduced.

Click to see API and NGINX Plus version table

API version	NGINX Plus version
4	R18
5	R19
6	R20
7	R25
8	R27

Using the Go library

Import the library using:

import "github.com/qba73/ngx"

Creating a client

Create a new Client object by calling ngx.NewClient(baseURL)

client, err := ngx.NewClient("http://localhost:8080/api")
if err != nil {
    // handle error
}

Or create a client with customized http Client:

customHTTPClient := &http.Client{}

client, err := ngx.NewClient(
    "http://localhost:8080/api",
    ngx.WithHTTPClient(customHTTPClient),
)
if err != nil {
    // handle error
}

Or create a client to work with specific version of NGINX instance:

client, err := ngx.NewClient(
    "http://localhost:8080/api",
    ngx.WithVersion(7),
)
if err != nil {
    // handle error
}

Testing

Run tests

make dox

Click to see test run results

$ gotestdox
 ✔ Check server updates is valid on valid input (0.00s)
 ✔ Check stream server updates is valid on valid input (0.00s)
 ✔ Upstream servers config is valid on valid input (0.00s)
 ✔ Upstream stream servers configuration is valid on valid input (0.00s)
 ✔ Server address is valid on valid input with host and port (0.00s)
 ✔ Server address is valid on valid input with IPV6 address and without port (0.00s)
 ✔ Server address is valid on valid input with IPV4 address and without port (0.00s)
 ✔ Server address is valid on valid input with address and without port (0.00s)
 ✔ Server address is valid on valid input with unix socket (0.00s)
 ✔ Server address is valid on valid input with IPV6 and port (0.00s)
 ✔ Server address is valid on valid input with IPV4 and port (0.00s)
 ✔ NGINX server status is valid on valid input request params (0.00s)
 ✔ Request get NGINXURL is valid on valid fields (0.00s)
 ✔ Get NGINX status errors on invalid request param (0.00s)
 ✔ Client uses valid request path on valid request params (0.00s)
 ✔ Client retrives info about running NGINX instance (0.00s)
 ✔ Client retrives NGINX status on valid parameters (0.00s)

Contributing

If you have any suggestions or experience issues with the NGINX Plus Go Client, please create an issue or send a pull request on GitHub.