https://github.com/lloydmeta/todddo-openapi

Exploring DDD, dependency-management, testing, web in the world of Golang.
https://github.com/lloydmeta/todddo-openapi

ddd gin go golang mock openapi swagger testing

Last synced: 4 days ago
JSON representation

Exploring DDD, dependency-management, testing, web in the world of Golang.

• Host: GitHub
• URL: https://github.com/lloydmeta/todddo-openapi
• Owner: lloydmeta
• Created: 2019-08-19T08:12:02.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-08-19T11:17:20.000Z (about 5 years ago)
• Last Synced: 2024-10-12T09:43:57.912Z (about 1 month ago)
• Topics: ddd, gin, go, golang, mock, openapi, swagger, testing
• Language: Go
• Size: 155 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Golang exploration [![Build Status](https://travis-ci.org/lloydmeta/todddo-openapi.svg?branch=master)](https://travis-ci.org/lloydmeta/todddo-openapi) [![codecov](https://codecov.io/gh/lloydmeta/todddo-openapi/branch/master/graph/badge.svg)](https://codecov.io/gh/lloydmeta/todddo-openapi)

A simple Todo list server implementation, but explores:

1. [Gomodules](https://github.com/golang/go/wiki/Modules) for dep management

2. DDD-esque go-style project structuring

    - Pure `domain` module holds models, repos and services

    - `infra` module holds tech-specific `domain` implementations

    - `api` module defines controllers and modules, and uses `domain` constructs

    - `app` instantiates and holds components needed booting up a server in `main.go`; this module also knows about the 

      concrete `infra` and web framework used (kept web framework separate from `infra` because it's top-level and can change

      independently of other tech relatively easily)

3. Go test, with an eye on maximising testability by enabling mocking of interfaces.

4. Auto-generated Swagger/OpenAPI clients via [Swaggo](https://github.com/swaggo/swag)

5. Easy to understand dependency-injection by building a components graph by hand

6. The [Gin](https://gin-gonic.com) web framework

### Usage

### Running

1. [Install `Go`](https://golang.org/doc/install)

2. Clone this repo

3. `go run main.go` and hit the endpoints.

  - For Swagger, go to [localhost:8080/swagger/index.html](http://localhost:8080/swagger/index.html)

    ![Swagger](swagger.png)

### Dev

1. [Install `Go`](https://golang.org/doc/install)

2. Use your favourite editor/IDE

3. For updating Swagger docs:

    1. Install [Swaggo](https://github.com/swaggo/swag#getting-started)

    2. Run `swag init` from the root project dir

    3. Commit the generated files.