dis-redirect-api

command module
v0.37.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 3, 2025 License: MIT Imports: 10 Imported by: 0

README

dis-redirect-api

A Go API for management of redirects.

Getting started

Dependencies
  • No further dependencies other than those defined in go.mod
Tools

To run some of our tests you will need additional tooling:

Audit

We use dis-vulncheck to do Go auditing, which you will need to install.

For Java auditing we use mvn ossindex:audit which requires you to setup an OSS Index account and make some updates to Maven: Local Setup for ossindex:audit

Linting

We use v2 of golangci-lint, which you will need to install.

Validating Specification

To validate the swagger specification you can do this via:

make validate-specification

To run this, you will need to run Node > v20 and have redocly CLI installed:

npm install -g redocly-cli
Configuration
Environment variable Default Description
BIND_ADDR :29900 The host and port to bind to
GRACEFUL_SHUTDOWN_TIMEOUT 5s The graceful shutdown timeout in seconds (time.Duration format)
HEALTHCHECK_INTERVAL 30s Time between self-healthchecks (time.Duration format)
HEALTHCHECK_CRITICAL_TIMEOUT 90s Time to wait until an unhealthy dependent propagates its state to make this app unhealthy (time.Duration format)
OTEL_EXPORTER_OTLP_ENDPOINT localhost:4317 Endpoint for OpenTelemetry service
OTEL_SERVICE_NAME dis-redirect-api Label of service for OpenTelemetry service
OTEL_BATCH_TIMEOUT 5s Timeout for OpenTelemetry
OTEL_ENABLED false Feature flag to enable OpenTelemetry
REDIS_ADDRESS localhost:6379 Endpoint for Redis service
SDKs

This API has two SDKs available:

Contributing

See CONTRIBUTING for details.

License

Copyright © 2025, Office for National Statistics (https://www.ons.gov.uk)

Released under MIT license, see LICENSE for details.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
features
sdk
go

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL