Skip to content

README.md

Latest commit

 

History

History
214 lines (171 loc) · 6.29 KB

README.md

File metadata and controls

214 lines (171 loc) · 6.29 KB

ServiceFile

Run Tests Go Report Card GoDoc

A standardized approach to describing microservices and their relationships through structured specification file and automated parsing tools.

Installation

# Install directly with Go
go install github.com/holydocs/servicefile/cmd/servicefile@latest

Quick Start

1. Document Your Service

Add structured comments to your Go code to describe your service:

/*
service:name UserService
description: Handles user authentication and profile management
owner: team-auth
tags: auth, user-management, microservice
*/
package main

// Service that uses PostgreSQL for data storage
/*
service:uses PostgreSQL
description: Stores user data and authentication tokens
technology:postgresql
proto:tcp
*/
type UserRepository struct {
    db *sql.DB
}

// Service that provides gRPC APIs
/*
service:replies
description: Provides user management APIs to other services
technology:grpc-server
proto:grpc
*/
type UserServer struct {
    repo *UserRepository
}

// Service that makes HTTP requests to external service
/*
service:requests NotificationService
description: Sends user notifications via email and SMS
technology:notification-service
proto:http
*/
type NotificationClient struct {
    httpClient *http.Client
}

// Service that replies to user requests
/*
service:replies User
description: Provides web interface for user interactions
technology:http-server
proto:http
person:true
*/
type WebServer struct {
    router *gin.Engine
}

2. Generate Your ServiceFile

Use the CLI tool to generate a service file from your Go code:

# Generate from current directory
servicefile generate

# Generate from specific directory
servicefile generate --dir ./my-service

# Generate recursively (default)
servicefile generate --recursive

# Specify output file
servicefile generate --output my-service.yaml

# Disable go.mod dependency inference
servicefile generate --analyze-go-mod=false

3. Generated Output

The tool generates a servicefile.yaml with your service description:

servicefile: "0.1.0"
info:
    name: UserService
    description: Handles user authentication and profile management
    owner: team-auth
    tags:
        - auth
        - user-management
        - microservice
relationships:
  - action: uses
    participant: PostgreSQL
    description: Stores user data and authentication tokens
    technology: postgresql
    proto: tcp
  - action: replies
    description: Provides user management APIs to other services
    technology: grpc-server
    proto: grpc
  - action: requests
    participant: NotificationService
    description: Sends user notifications via email and SMS
    technology: notification-service
    proto: http
  - action: replies
    participant: User
    description: Provides web interface for user interactions
    technology: http-server
    proto: http
    person: true

ServiceFile Specification

Service Metadata

  • servicefile: The version of the ServiceFile specification
  • info.name: The name of your service
  • info.description: A description of what your service does
  • info.system: (Optional) The larger system or platform this service belongs to
  • info.owner: (Optional) The team or individual responsible for this service
  • info.repository: (Optional) The URL of repository
  • info.tags: (Optional) A list of tags to categorize and organize your service

Relationship Actions

ServiceFile supports several relationship types:

  • service:uses: Service depends on another service/database
  • service:requests: Service makes requests to another service
  • service:replies: Service provides APIs for other services/persons
  • service:sends: Service sends messages/events
  • service:receives: Service receives messages/events

Relationship Properties

Each relationship can have:

  • participant: The name of the related service/resource
  • description: Description of the relationship
  • technology: Technology or product used (e.g., postgresql, redis, firebase, kafka)
  • external: (Optional) Whether this is an external dependency (e.g., true, false)
  • person: (Optional) Whether this relationship is with a person rather than a service or system (e.g., true, false)
  • proto: (Optional) Communication protocol used (e.g., http, grpc, tcp, udp, amqp)
  • tags: (Optional) A list of tags to categorize and organize the relationship (e.g., persistence, security, critical)

Multiple Services in a Single Codebase

ServiceFile supports documenting and extracting multiple services from a single codebase or monorepo. Each service should be defined with its own service:name comment block. Relationships can be attached to a specific service using the service:{service_name}:{action} format:

/*
service:name UserService
description: Handles user authentication
tags: auth, user-management
*/

// service:UserService:uses DatabaseService
// technology:postgres
// description: Uses PostgreSQL for user data
// tags:persistence, critical

/*
service:name NotificationService
description: Handles user notifications
tags: notification, messaging
*/

// service:NotificationService:requests EmailService
// technology:http
// description: Requests email delivery
// tags:external, email

/*
service:name WebService
description: Handles web interface and user interactions
tags: web, frontend
*/

// service:WebService:replies User
// technology:http
// description: Provides web interface to users
// person:true

When you run the parser, it will generate a separate YAML file for each service (e.g., userservice.servicefile.yaml, notificationservice.servicefile.yaml).

If only one service is found, the output will be a single file (e.g., servicefile.yaml).

Examples

See the internal/parser/golang/testdata/default directory for complete examples of how to document services using ServiceFile comments.