Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nginx/nginx-plus-go-client
A client for NGINX Plus API for Go
https://github.com/nginx/nginx-plus-go-client
golang nginx
Last synced: about 24 hours ago
JSON representation
A client for NGINX Plus API for Go
- Host: GitHub
- URL: https://github.com/nginx/nginx-plus-go-client
- Owner: nginx
- License: apache-2.0
- Created: 2018-04-18T11:41:54.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-01-09T01:23:37.000Z (1 day ago)
- Last Synced: 2025-01-09T01:55:03.304Z (1 day ago)
- Topics: golang, nginx
- Language: Go
- Homepage:
- Size: 567 KB
- Stars: 49
- Watchers: 15
- Forks: 24
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://scorecard.dev/viewer/?uri=github.com/nginxinc/nginx-plus-go-client)
[](https://github.com/nginxinc/nginx-plus-go-client/actions)
[](https://opensource.org/licenses/Apache-2.0)
[](https://goreportcard.com/report/github.com/nginxinc/nginx-plus-go-client)
[](https://app.fossa.com/projects/custom%2B5618%2Fgithub.com%2Fnginxinc%2Fnginx-plus-go-client?ref=badge_shield)
[](https://github.com/nginxinc/nginx-plus-go-client/releases/latest)
[](https://nginxcommunity.slack.com)
[](https://www.repostatus.org/#active)
[](https://github.com/nginxinc/nginx-plus-go-client/blob/main/SECURITY.md)
# NGINX Plus Go Client
This project includes a client library for working with NGINX Plus API.
## Table of Contents
- [About the Client](#about-the-client)
- [Compatibility](#compatibility)
- [Using the Client](#using-the-client)
- [Testing](#testing)
- [Unit tests](#unit-tests)
- [Integration tests](#integration-tests)
- [Contacts](#contacts)
- [Contributing](#contributing)
- [Support](#support)
## About the Client
`client/nginx.go` includes functions and data structures for working with NGINX Plus API as well as some helper
functions.
## Compatibility
This Client works against versions 4 to 9 of the NGINX Plus API. The table below shows the version of NGINX Plus where
the API was first introduced.
| API version | NGINX Plus version |
|-------------|--------------------|
| 4 | R18 |
| 5 | R19 |
| 6 | R20 |
| 7 | R25 |
| 8 | R27 |
| 9 | R30 |
## Using the Client
1. Import `github.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.
## Testing
### Unit tests
```console
cd client
go test
```
### Integration tests
Prerequisites:
- Docker
- Docker Compose
- golang
- Make
- NGINX Plus license - put `nginx-repo.crt` and `nginx-repo.key` into the `docker` folder.
Run Tests:
```console
make test
```
This will build and run two NGINX Plus containers and create one docker network of type bridge, execute the client tests
against both NGINX Plus APIs, and then clean up. If it fails and you want to clean up (i.e. stop the running containers
and remove the docker network), please use `make clean`
## Contacts
We’d like to hear your feedback! 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. You can contact us directly via or on the
[NGINX Community Slack](https://nginxcommunity.slack.com).
## Contributing
If you'd like to contribute to the project, please read our [Contributing guide](CONTRIBUTING.md).
## Support
This project is not covered by the NGINX Plus support contract.