Skip to content

Commit 74b412d

Browse files
cebecebe
committed
Added a docker stack
1 parent c40face commit 74b412d

File tree

9 files changed

+169
-16
lines changed

9 files changed

+169
-16
lines changed

‎Makefile‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,21 @@ test:
2323
clean: stop
2424

2525
.PHONY: start stop clean test
26+
27+
docker-up: config/components-dev.local.php config/components-test.local.php env.php stop
28+
docker-compose up -d
29+
docker-compose exec backend-php sh -c 'cd /app && composer install'
30+
@echo ""
31+
@echo "API: http://localhost:8337/"
32+
@echo "API docs: http://localhost:8337/docs/index.html"
33+
@echo "Backend: http://localhost:8338/"
34+
@echo ""
35+
36+
cli:
37+
docker-compose exec backend-php bash
38+
39+
# copy config files if they do not exist
40+
config/components-%.local.php: config/components-ENV.local.php
41+
test -f $@ || cp $< $@
42+
env.php: env.php.dist
43+
test -f $@ || cp $< $@

‎README.md‎

Lines changed: 61 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,70 @@ Based on [yii2-openapi](https://github.com/cebe/yii2-openapi) (code generator) a
1515

1616
[![asciicast](https://asciinema.org/a/GSnZFeL0beAwLvbhIn50oVI9w.svg)](https://asciinema.org/a/GSnZFeL0beAwLvbhIn50oVI9w)
1717

18+
1819
## Overview
1920

20-
This application template consists of 3 application tiers:
21+
This application template does not contain any useful code, it only provides the [directory structure](#structure) for your API project.
22+
All the code is generated from an [OpenAPI](https://www.openapis.org/about) API description file.
2123

22-
- `api`, contains the Yii application for the REST API.
23-
- `console`, contains the Yii application for console commands, cronjobs or queues (`yii` command).
24-
- `backend`, contains the Yii application for a CRUD backend on the API data.
24+
When working with this template you follow the [API Design-First Approach](https://apisyouwonthate.com/blog/api-design-first-vs-code-first).
25+
So to get started building an API with this application template you need an API description first.
26+
If you don't have one yet, you might want to check the following resources first:
27+
28+
- [OpenAPI 3.0 tutorial](https://idratherbewriting.com/learnapidoc/pubapis_openapi_tutorial_overview)
29+
- [OpenAPI Specification Version 3.0.2](http://spec.openapis.org/oas/v3.0.2)
30+
31+
If you have an OpenAPI description, you can continue with the next steps:
32+
33+
1. [Setup](#setup)
34+
2. [Generate Code](#generate-code)
2535

2636

27-
## Setup
37+
## Setup <span id="setup"></span>
38+
39+
There are two different ways:
40+
41+
- PHP directly on your machine
42+
- Using Docker
43+
44+
### PHP directly
45+
46+
Having PHP and a database server installed on your machine, you can run the following commands:
2847

2948
composer create-project cebe/yii2-app-api my-api
3049
cd my-api
3150
cp env.php.dist env.php
51+
cp config/components-ENV.local.php config/components-dev.local.php
52+
53+
You need to adjust `config/components-dev.local.php` to configure your database connection.
54+
55+
After that, run `make start` and `make stop` to control the PHP webservers for API and backend.
56+
57+
You can now continue with [generating code](#generate-code).
58+
59+
### Using Docker
3260

33-
## Generate Code
61+
You need [Docker](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/) installed.
62+
For the easiest way you need GNU make, then run:
63+
64+
make docker-up
65+
66+
This uses `docker-compose` to start docker containers for the API and the backend including a database.
67+
68+
You can now continue with [generating code](#generate-code).
69+
70+
> Note: If you don't have GNU make, you need to copy the configuration files as in the PHP directly section, then run:
71+
>
72+
> docker-compose up -d
73+
> docker-compose exec backend-php sh -c 'cd /app && composer install'
74+
75+
76+
## Generate Code <span id="generate-code"></span>
3477

3578
### Console
3679

80+
> Tip: If you use Docker, run `make bash` before running any of these commands.
81+
3782
Run `./yii gii/api` to generate your API code. The `--openApiPath` parameter specifies the path to your OpenAPI
3883
spec file. The following example will generate API code for the [OpenAPI petstore example](https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/examples/v3.0/petstore-expanded.yaml).
3984

@@ -48,12 +93,7 @@ Then set up the database:
4893

4994
### Web
5095

51-
To use the web generator, start the backend server:
52-
53-
cd backend
54-
make start
55-
56-
open `http://localhost:8338/gii` and select the `REST API Generator`.
96+
To use the web generator, open <http://localhost:8338/gii> and select the `REST API Generator`.
5797

5898
![Gii - REST API Generator](docs/img/gii-generator.png)
5999

@@ -94,7 +134,15 @@ Your API is now available at `http://localhost:8337/`. Try to access an endpoint
94134
...
95135
]
96136

97-
## Application structure
137+
## Application structure <span id="structure"></span>
138+
139+
This application template consists of 3 application tiers:
140+
141+
- `api`, contains the Yii application for the REST API.
142+
- `console`, contains the Yii application for console commands, cronjobs or queues (`yii` command).
143+
- `backend`, contains the Yii application for a CRUD backend on the API data.
144+
145+
The following list explains the directory structure in more detail:
98146

99147
- `api/` - API application tier
100148
- `config/` - configuration for API tier

‎api/Dockerfile‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
FROM yiisoftware/yii2-php:7.3-apache
2+
3+
COPY config/apache.conf /etc/apache2/sites-enabled/000-default.conf

‎api/config/apache.conf‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Apache Server configuration for the docker container
2+
# This is not suitable for production use!
3+
<Directory /app/api/web/>
4+
Options Indexes FollowSymLinks
5+
AllowOverride All
6+
Require all granted
7+
</Directory>
8+
9+
<VirtualHost *:80>
10+
ServerAdmin webmaster@localhost
11+
DocumentRoot /app/api/web
12+
13+
ErrorLog /app/logs/api-error.log
14+
CustomLog /app/logs/api-access.log combined
15+
</VirtualHost>

‎backend/Dockerfile‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
FROM yiisoftware/yii2-php:7.3-apache
2+
3+
COPY config/apache.conf /etc/apache2/sites-enabled/000-default.conf

‎backend/config/apache.conf‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Apache Server configuration for the docker container
2+
# This is not suitable for production use!
3+
<Directory /app/backend/web/>
4+
Options Indexes FollowSymLinks
5+
AllowOverride All
6+
Require all granted
7+
</Directory>
8+
9+
<VirtualHost *:80>
10+
ServerAdmin webmaster@localhost
11+
DocumentRoot /app/backend/web
12+
13+
ErrorLog /app/logs/backend-error.log
14+
CustomLog /app/logs/backend-access.log combined
15+
</VirtualHost>

‎backend/config/app-dev.php‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,17 @@
2020
'class' => yii\gii\Module::class,
2121
// add ApiGenerator to Gii module
2222
'generators' => require __DIR__ . '/../../config/gii-generators.php',
23+
'allowedIPs' => [
24+
'127.0.0.1', '::1',
25+
// possible docker subnets
26+
// 172.16.0.0/12 (gii does not understand CIDR :-/)
27+
'172.16.*', '172.17.*', '172.18.*', '172.19.*', '172.20.*', '172.21.*', '172.22.*', '172.23.*', '172.24.*', '172.25.*',
28+
'172.26.*', '172.27.*', '172.28.*', '172.29.*', '172.30.*', '172.31.*',
29+
// 192.168.0.0/16
30+
'192.168.*',
31+
// 10.0.0.0/8
32+
'10.*',
33+
],
2334
];
2435

2536
return $config;

‎config/components-ENV.local.php‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,10 @@
1212
return [
1313
'db' => [
1414
'class' => yii\db\Connection::class,
15-
'dsn' => 'mysql:host=localhost;dbname=api_db',
16-
'username' => 'root',
17-
'password' => '',
15+
'dsn' => 'mysql:host=db;dbname=api_db', // for docker
16+
//'dsn' => 'mysql:host=localhost;dbname=api_db', // use this when mysql runs on your local host
17+
'username' => 'api',
18+
'password' => 'apisecret',
1819
'charset' => 'utf8',
1920
],
2021
];

‎docker-compose.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Development stack overrides
2+
#
3+
# Variables are populated with values from `.env`
4+
#
5+
version: '2'
6+
services:
7+
api-php:
8+
build: api
9+
ports:
10+
- '8337:80'
11+
volumes:
12+
# Mount source-code for development
13+
- ./:/app
14+
15+
backend-php:
16+
build: backend
17+
ports:
18+
- '8338:80'
19+
volumes:
20+
# Re-use local composer cache via host-volume
21+
- ~/.composer-docker/cache:/root/.composer/cache:delegated
22+
# Mount source-code for development
23+
- ./:/app
24+
25+
db:
26+
image: mysql:5.7
27+
environment:
28+
#- MYSQL_ROOT_PASSWORD=verysecret
29+
- MYSQL_DATABASE=api_db
30+
- MYSQL_USER=api
31+
- MYSQL_PASSWORD=apisecret
32+
33+
redis:
34+
image: redis:3
35+
36+
mailcatcher:
37+
image: nisenabe/mailcatcher
38+
ports:
39+
- '80'

0 commit comments

Comments
 (0)