Repository files navigation

This project includes a client library for working with NGINX Plus API.

• About the Client
• Compatibility
• Using the Client
• Testing
  • Unit tests
  • Integration tests
• Contacts
• Contributing
• Support

client/nginx.go includes functions and data structures for working with NGINX Plus API as well as some helperfunctions.

This Client works against versions 4 to 9 of the NGINX Plus API. The table below shows the version of NGINX Plus wherethe API was first introduced.

1. Importgithub.com/nginxinc/nginx-plus-go-client/client into your go project.
2. Use your favorite vendor tool to add this to your/vendor directory in your project.

cd clientgo test

Prerequisites:

• Docker
• Docker Compose
• golang
• Make
• NGINX Plus license - putnginx-repo.crt andnginx-repo.key into thedocker folder.

Run Tests:

make test

This will build and run two NGINX Plus containers and create one docker network of type bridge, execute the client testsagainst both NGINX Plus APIs, and then clean up. If it fails and you want to clean up (i.e. stop the running containersand remove the docker network), please usemake clean

We’d like to hear your feedback! If you have any suggestions or experience issues with the NGINX Plus Go Client, pleasecreate an issue or send a pull request on GitHub. You can contact us directly viaintegrations@nginx.com or on theNGINX Community Slack.

If you'd like to contribute to the project, please read ourContributing guide.

This project is not covered by the NGINX Plus support contract.