rest

package

v1.0.0 Latest Latest Go to latest Published: Jun 24, 2025 License: CC-BY-SA-4.0 Imports: 7 Imported by: 0

Details

Package rest provides link services with a REST API over HTTP.

Package rest provides link management services over HTTP.

mux := http.NewServeMux()
mux.Handle("POST /shorten", Shorten(...))
mux.Handle("GET /r/{key}", Resolve(...))
mux.HandleFunc("GET /health", Health)

Shorten a URL:

$ curl localhost:8080/shorten -d '{"url":"https://x.com/inancgumus"}'

Resolve a shortened URL:

$ curl localhost:8080/r/639508a7

Health check:

$ curl localhost:8080/health

This section is empty.

This section is empty.

func Health(w http.ResponseWriter, r *http.Request)

Health serves the health check requests.

func Resolve(lg *slog.Logger, links Resolver) http.Handler

Resolve returns an HTTP handler that resolves shortened link URLs. It extracts a {key} from http.Request using http.Request.PathValue.

func Shorten(lg *slog.Logger, links Shortener) http.Handler

Shorten returns an http.Handler that shortens URLs.

type Resolver interface {
	// Resolve retrieves a link by its key.
	Resolve(context.Context, link.Key) (link.Link, error)
}

Resolver is a link resolver service that resolves shortened URLs.

type Shortener interface {
	// Shorten shortens a link and returns its key.
	Shorten(context.Context, link.Link) (link.Key, error)
}

Shortener is a link shortener service that shortens URLs.