All examples

Go HTTP service

Standard-library HTTP service with method-pattern routing, pgx and sqlc, slog logging, and table-driven tests.

Composed from the go-http-service rules pack. Same file from the CLI: aibysitter init --packs go-http-service --format agents

Written for this site, CC0, scored by this linter, not tested against any agent.

File

AGENTS.md, 40 lines

Format

AGENTS.md

Save as

AGENTS.md

Category

Go

Tags

• Go
• net/http
• PostgreSQL
• sqlc
• slog

License

CC0 1.0, public domain. No attribution needed.

Download AGENTS.md Lint a copy

Badge

Markdown for a README:

[![Aibysitter lint score: A 100](https://aibysitting.net/gallery/go-http-service/badge.svg)](https://aibysitting.net/Gallery/go-http-service)

AGENTS.md

View rendered

# Go HTTP service

Go HTTP service. Standard library `net/http` routing, PostgreSQL through `pgx`, queries generated by `sqlc`.

## Commands
- Build: `go build ./...`
- Test: `go test -race ./...`
- Vet: `go vet ./...`
- Lint: `golangci-lint run`
- Format check: `gofmt -l .` prints nothing
- Regenerate queries after editing `db/queries/*.sql`: `sqlc generate`

## Layout
- `cmd/<app>/main.go`: wiring only. Config, logger, server start.
- `internal/http/`: handlers and routes.
- `internal/<domain>/`: domain logic. No `net/http` imports.
- `internal/db/`: generated sqlc code. Files in this directory are not edited by hand.

## Handlers
- Routes are registered with method patterns: `mux.HandleFunc("POST /messages", h.createMessage)`.
- JSON bodies are decoded with `json.NewDecoder(r.Body)` and `DisallowUnknownFields()`.
- Errors are written with `writeError(w, status, code, message)` from `internal/http/errors.go`.
- Handlers get their dependencies from the `Handler` struct. No package-level state.

## Errors and context
- Wrap errors with context: `fmt.Errorf("load account: %w", err)`. Compare them with `errors.Is` and `errors.As`.
- Every function that does I/O takes `ctx context.Context` as its first parameter.
- Request paths do not call `context.Background()`.

## Logging
- `log/slog` with JSON output. Keys are snake_case: `slog.Info("message sent", "message_id", id)`.
- Message bodies and personal data are never logged.

## Tests
- Table-driven tests with one `t.Run` per case.
- Handlers are tested with `httptest.NewRecorder` and fakes for external clients.
- Database tests carry the `//go:build integration` tag and run with `go test -tags integration ./...`.

## Dependencies
- Add a module only when the task requires it, and name it in the PR description.

1. # Go HTTP service
3. Go HTTP service. Standard library `net/http` routing, PostgreSQL through `pgx`, queries generated by `sqlc`.
5. ## Commands
6. - Build: `go build ./...`
7. - Test: `go test -race ./...`
8. - Vet: `go vet ./...`
9. - Lint: `golangci-lint run`
10. - Format check: `gofmt -l .` prints nothing
11. - Regenerate queries after editing `db/queries/*.sql`: `sqlc generate`
13. ## Layout
14. - `cmd/<app>/main.go`: wiring only. Config, logger, server start.
15. - `internal/http/`: handlers and routes.
16. - `internal/<domain>/`: domain logic. No `net/http` imports.
17. - `internal/db/`: generated sqlc code. Files in this directory are not edited by hand.
19. ## Handlers
20. - Routes are registered with method patterns: `mux.HandleFunc("POST /messages", h.createMessage)`.
21. - JSON bodies are decoded with `json.NewDecoder(r.Body)` and `DisallowUnknownFields()`.
22. - Errors are written with `writeError(w, status, code, message)` from `internal/http/errors.go`.
23. - Handlers get their dependencies from the `Handler` struct. No package-level state.
25. ## Errors and context
26. - Wrap errors with context: `fmt.Errorf("load account: %w", err)`. Compare them with `errors.Is` and `errors.As`.
27. - Every function that does I/O takes `ctx context.Context` as its first parameter.
28. - Request paths do not call `context.Background()`.
30. ## Logging
31. - `log/slog` with JSON output. Keys are snake_case: `slog.Info("message sent", "message_id", id)`.
32. - Message bodies and personal data are never logged.
34. ## Tests
35. - Table-driven tests with one `t.Run` per case.
36. - Handlers are tested with `httptest.NewRecorder` and fakes for external clients.
37. - Database tests carry the `//go:build integration` tag and run with `go test -tags integration ./...`.
39. ## Dependencies
40. - Add a module only when the task requires it, and name it in the PR description.