[update] v.2.0.0 - Clean Architecture

.circleci/config.yml

@@ -0,0 +1,57 @@
+jobs-references:
+  go-container: &go-container
+    docker:
+      - image: circleci/golang:1.11.9
+        environment:
+          GO111MODULE: "on"
+    working_directory: /go/src/github.com/github.com/bmf-san/go-api-boilerplate/app
+  setup_go_packages: &setup_go_packages
+    run:
+      name: Setup go packages
+      command: |
+        go get -u golang.org/x/lint/golint
+        go get -u github.com/go-sql-driver/mysql
+
+version: 2
+jobs:
+  mod:
+    <<: *go-container
+    steps:
+      - checkout
+      - *setup_go_packages
+      - run:
+          name: "Run mod"
+          command: |
+            go mod download
+  golint:
+    <<: *go-container
+    steps:
+      - checkout
+      - *setup_go_packages
+      - run:
+          name: Run golint
+          command: golint ./...
+  vet:
+    <<: *go-container
+    steps:
+      - checkout
+      - *setup_go_packages
+      - run:
+          name: Run vet
+          command: go vet ./...
+  test:
+    <<: *go-container
+    steps:
+      - checkout
+      - *setup_go_packages
+      - run:
+          name: Run test
+          command: go test -v -race ./...
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - golint
+      - vet
+      - test

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = false
+
+[*.go]
+indent_style = tab

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at bmf.infomation@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing
+
+Feel free to contribute ! :)
+
+If you have some questions, requests or something, let me know it.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+# Overview
+
+# Changes
+
+# Impact range
+
+# Operational Requirements
+
+# Related Issue
+
+# Supplement

.gitignore

@@ -1,2 +1,7 @@
+launch.json
 /app/.env
-launch.json
+.DS_STORE
+/app/go_api_boilerplate
+/app/log/*
+!/app/log/.gitkeep
+.vscode/

README.md

@@ -12,7 +12,81 @@ This is an api boilerplate built with golang.
 
 After running docker, you need to execute sql files in `app/database/sql`.
 
-# References
-I refered to this repository.
+# Architecture
+```
+app/
+├── database
+│   ├── migrations
+│   │   └── schema.sql
+│   └── seeds
+│       └── faker.sql
+├── domain
+│   ├── post.go
+│   └── user.go
+├── infrastructure
+│   ├── env.go
+│   ├── logger.go
+│   ├── router.go
+│   └── sqlhandler.go
+├── interfaces
+│   ├── post_controller.go
+│   ├── post_repository.go
+│   ├── sqlhandler.go
+│   ├── user_controller.go
+│   └── user_repository.go
+├── log
+│   ├── access.log
+│   └── error.log
+├── main.go
+├── test.log
+└── usecases
+    ├── logger.go
+    ├── post_interactor.go
+    ├── post_repository.go
+    ├── user_interactor.go
+    └── user_repository.go
+```
+
+| Layer                | Directory      | Sub directory                        |
+|----------------------|----------------|--------------------------------------|
+| Frameworks & Drivers | infrastructure | database, router, env                |
+| Interface            | interfaces     | controllers, database, repositories  |
+| Usecases             | usecases       | repositories                         |
+| Entities             | domain         | ex. user.go                          |
+
+# API Document
+// TODO: This section will be updated the date when ver.3.0.0 will be released.
+
+
+# Controller method naming rule
+Use these word as prefix.
 
-- [github - rymccue/golang-standard-lib-rest-api](https://github.com/rymccue/golang-standard-lib-rest-api)
+- index
+  - Display a listing of the resource.
+- show
+  - Display the specified resource.
+- store
+  - Store a newly created resource in storage.
+- update
+  - Update the specified resource in storage.
+- destory
+  - Remove the specified resource from storage.
+
+# Repository method naming rule
+Use these word as prefix.
+
+- get
+- add
+- update
+- delete
+
+# References
+- [github - manuelkiessling/go-cleanarchitecture](https://github.com/manuelkiessling/go-cleanarchitecture)
+- [github - rymccue/golang-standard-lib-rest-api](https://github.com/rymccue/golang-standard-lib-rest-api)
+- [github - hirotakan/go-cleanarchitecture-sample](https://github.com/hirotakan/go-cleanarchitecture-sample)
+- [Recruit Technologies - Go言語とDependency Injection](https://recruit-tech.co.jp/blog/2017/12/11/go_dependency_injection/)
+- [Clean ArchitectureでAPI Serverを構築してみる](https://qiita.com/hirotakan/items/698c1f5773a3cca6193e)
+- [github - ponzu-cms/ponzu](https://github.com/ponzu-cms/ponzu)
+- [クリーンアーキテクチャの書籍を読んだのでAPIサーバを実装してみた](https://qiita.com/yoshinori_hisakawa/items/f934178d4bd476c8da32)
+- [Go × Clean Architectureのサンプル実装](http://nakawatch.hatenablog.com/entry/2018/07/11/181453)
+- [Uncle Bob – Payroll Case Study (A full implementation)](http://cleancodejava.com/uncle-bob-payroll-case-study-full-implementation/)

app/.realize.yaml

@@ -6,8 +6,12 @@ schema:
 - name: go-api-boilerplate
   path: .
   commands:
+    build:
+      status: true
+      method: go build -o go_api_boilerplate
     run:
       status: true
+      method: ./go_api_boilerplate
   watcher:
     extensions:
     - go

app/database/migrations/schema.sql

@@ -0,0 +1,16 @@
+CREATE TABLE
+IF NOT EXISTS `users`
+(
+    `id` INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
+    `name` VARCHAR
+(255)
+) ENGINE = InnoDB DEFAULT CHARSET = utf8
+;
+CREATE TABLE
+IF NOT EXISTS `posts`
+(
+    `id` INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
+    `user_id` INT UNSIGNED NOT NULL,
+    `body` TEXT
+) ENGINE = InnoDB DEFAULT CHARSET = utf8
+;

app/database/seeds/faker.sql

@@ -0,0 +1,14 @@
+INSERT INTO users
+  (name)
+VALUES('foo');
+INSERT INTO users
+  (name)
+VALUES('bar');
+
+INSERT INTO posts
+  (user_id, body)
+VALUES(1, 'Hello World');
+INSERT INTO posts
+  (user_id, body)
+VALUES
+  (2, 'Hi');

app/domain/post.go

@@ -0,0 +1,11 @@
+package domain
+
+// A Posts belong to the domain layer.
+type Posts []Post
+
+// A Post belong to the domain layer.
+type Post struct {
+	ID     int    `json:"id"`
+	UserID int    `json:"user_id"`
+	Body   string `json:"body"`
+}