go-create-service

Original：🇺🇸 English

Translated

Generate Go services following GO modular architechture conventions (Fx DI, OTEL tracing, interface-first design). Use when creating reusable business services in internal/modules/<module>/service/ - email senders, token generators, hashing utilities, template compilers, cache-backed lookups, or any domain service that encapsulates a single responsibility and is consumed by use cases or other services.

2installs

Sourcecristiano-pacheco/ai-rules

Added on2026-02-13

NPX Install

npx skill4agent add cristiano-pacheco/ai-rules go-create-service

SKILL.md Content

View Translation Comparison →

Go Create Service

Generate service files for GO modular architechture conventions.

Three-File Pattern

Every service requires up to three files:

DTO structs (if needed):

internal/modules/<module>/dto/<service_name>_dto.go

Port interface:

internal/modules/<module>/ports/<service_name>_service.go

Service implementation:

internal/modules/<module>/service/<service_name>_service.go

DTO File Layout Order

Input/output structs

Port File Layout Order

Interface definition (
```
XxxService
```
— no suffix)

Service File Layout Order

Implementation struct (
```
XxxService
```
)
Compile-time interface assertion
Constructor (
```
NewXxxService
```
)
Methods

DTO Structure

Location:

internal/modules/<module>/dto/<service_name>_dto.go

go

package dto

type DoSomethingInput struct {
	Field string
}

Port Interface Structure

Location:

internal/modules/<module>/ports/<service_name>_service.go

go

package ports

import (
	"context"

	"github.com/cristiano-pacheco/pingo/internal/modules/<module>/dto"
)

type DoSomethingService interface {
	Execute(ctx context.Context, input dto.DoSomethingInput) error
}

Service Implementation Structure

Location:

internal/modules/<module>/service/<service_name>_service.go

go

package service

import (
	"context"

	"github.com/cristiano-pacheco/bricks/pkg/logger"
    "github.com/cristiano-pacheco/bricks/pkg/otel/trace"
	"github.com/cristiano-pacheco/pingo/internal/modules/<module>/dto"
	"github.com/cristiano-pacheco/pingo/internal/modules/<module>/ports"
)

type DoSomethingService struct {
	logger logger.Logger
	// other dependencies
}

var _ ports.DoSomethingService = (*DoSomethingService)(nil)

func NewDoSomethingService(
	logger logger.Logger,
) *DoSomethingService {
	return &DoSomethingService{
		logger: logger,
	}
}

func (s *DoSomethingService) Execute(ctx context.Context, input dto.DoSomethingInput) error {
	ctx, span := trace.Span(ctx, "DoSomethingService.Execute")
	defer span.End()

	// Business logic here

	return nil
}

Service Variants

Single-action service (Execute pattern)

Use

Execute

method with a dedicated input struct when the service does one thing.

DTO (

dto/send_email_confirmation_dto.go

):

go

type SendEmailConfirmationInput struct {
	UserModel             model.UserModel
	ConfirmationTokenHash []byte
}

Port (

ports/send_email_confirmation_service.go

):

go

type SendEmailConfirmationService interface {
	Execute(ctx context.Context, input dto.SendEmailConfirmationInput) error
}

Multi-method service (named methods)

Use descriptive method names when the service groups related operations.

Port (

ports/hash_service.go

):

go

type HashService interface {
	GenerateFromPassword(password []byte) ([]byte, error)
	CompareHashAndPassword(hashedPassword, password []byte) error
	GenerateRandomBytes() ([]byte, error)
}

Stateless service (no dependencies)

Omit logger and config when the service is a pure utility with no I/O.

go

type HashService struct{}

func NewHashService() *HashService {
	return &HashService{}
}

Tracing

Services performing I/O MUST use

trace.Span

. Pure utilities (hashing, template compilation) skip tracing.

go

ctx, span := trace.Span(ctx, "ServiceName.MethodName")
defer span.End()

Span name format:

"StructName.MethodName"


## Naming

- Port interface: `XxxService` (in `ports` package, no suffix)
- Implementation struct: `XxxService` (in `service` package, same name — disambiguated by package)
- Constructor: `NewXxxService`, returns a pointer of the struct implementation

## Fx Wiring

Add to `internal/modules/<module>/fx.go`:

```go
fx.Provide(
	fx.Annotate(
		service.NewXxxService,
		fx.As(new(ports.XxxService)),
	),
),

Dependencies

Services depend on interfaces only. Common dependencies:

```
logger.Logger
```
— structured logging
Other
```
ports.XxxService
```
interfaces — compose services
```
ports.XxxRepository
```
— data access
```
ports.XxxCache
```
— caching layer

Critical Rules

Three files: DTOs in
```
dto/
```
, port interface in
```
ports/
```
, implementation in
```
service/
```
Interface in ports: Interface lives in
```
ports/<name>_service.go
```
DTOs in dto: Input/output structs live in
```
dto/<name>_dto.go
```

Interface assertion: Add

var _ ports.XxxService = (*XxxService)(nil)

below the struct

Constructor: MUST return pointer
```
*XxxService
```
Tracing: Every I/O method MUST use
```
trace.Span
```
with
```
defer span.End()
```
Context: Methods performing I/O accept
```
context.Context
```
as first parameter
No comments: Do not add redundant comments above methods
Dependencies: Always depend on port interfaces, never concrete implementations

Workflow

Create DTO file in
```
dto/<name>_dto.go
```
(if input/output structs are needed)
Create port interface in
```
ports/<name>_service.go
```
Create service implementation in
```
service/<name>_service.go
```
Add Fx wiring to module's
```
module.go
```
(or
```
fx.go
```
)
Run
```
make lint
```
to verify
Run
```
make nilaway
```
for static analysis

go-create-service

NPX Install

Tags

SKILL.md Content

Go Create Service

Three-File Pattern

DTO File Layout Order

Port File Layout Order

Service File Layout Order

DTO Structure

Port Interface Structure

Service Implementation Structure

Service Variants

Single-action service (Execute pattern)

Multi-method service (named methods)

Stateless service (no dependencies)

Tracing

Dependencies

Critical Rules

Workflow