Skip to content

Commit ed84d9e

Browse files
author
Vic Shóstak
committed
Update API docs
1 parent d7f97ce commit ed84d9e

File tree

12 files changed

+401
-129
lines changed

12 files changed

+401
-129
lines changed

‎.dockerignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Makefile
88
LICENSE
99
**/*.md
1010
**/*_test.go
11+
*.out
1112

1213
# Folders
1314
.git/

‎LICENSE‎

Lines changed: 201 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,201 @@
1-
MIT License
2-
3-
Copyright (c) 2021 Vic Shóstak <[email protected]> (https://1wa.co)
4-
5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
11-
12-
The above copyright notice and this permission notice shall be included in all
13-
copies or substantial portions of the Software.
14-
15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2021 Vic Shóstak <[email protected]> (https://shostak.dev)
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎Makefile‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
.PHONY: clean test security build run
1+
.PHONY: clean test security build run swag
22

33
APP_NAME = apiserver
44
BUILD_DIR = $(PWD)/build
55
MIGRATIONS_FOLDER = $(PWD)/platform/migrations
6-
DATABASE_URL = postgres://$(user):$(pass)@$(host)/$(table)?sslmode=disable
6+
DATABASE_URL = postgres://postgres:password@localhost/postgres?sslmode=disable
77

88
clean:
99
rm -rf ./build
@@ -17,7 +17,7 @@ test: security
1717
build: clean test
1818
CGO_ENABLED=0 go build -ldflags="-w -s" -o $(BUILD_DIR)/$(APP_NAME) main.go
1919

20-
run: swag.init build
20+
run: swag build
2121
$(BUILD_DIR)/$(APP_NAME)
2222

2323
migrate.up:
@@ -36,12 +36,12 @@ docker.network:
3636
docker network inspect dev-network >/dev/null 2>&1 || \
3737
docker network create -d bridge dev-network
3838

39-
docker.run: docker.network docker.net_http docker.postgres
39+
docker.run: docker.network docker.postgres swag docker.net_http migrate.up
4040

4141
docker.stop:
4242
docker stop dev-net_http dev-postgres
4343

44-
docker.net_http:
44+
docker.net_http: docker.build
4545
docker run --rm -d \
4646
--name dev-net_http \
4747
--network dev-network \
@@ -59,5 +59,5 @@ docker.postgres:
5959
-p 5432:5432 \
6060
postgres
6161

62-
swag.init:
62+
swag:
6363
swag init

‎README.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,30 +21,32 @@ cgapp create
2121
2. Rename `.env.example` to `.env` and fill it with your environment values.
2222
3. Install [Docker](https://www.docker.com/get-started) and the following useful Go tools to your system:
2323

24-
- [golang-migrate/migrate](https://github.com/golang-migrate/migrate#cli-usage) for apply migrations
25-
- [github.com/swaggo/swag](https://github.com/swaggo/swag) for auto-generating Swagger API docs
26-
- [github.com/securego/gosec](https://github.com/securego/gosec) for checking Go security issues
24+
- [golang-migrate/migrate](https://github.com/golang-migrate/migrate#cli-usage) for apply migrations
25+
- [github.com/swaggo/swag](https://github.com/swaggo/swag) for auto-generating Swagger API docs
26+
- [github.com/securego/gosec](https://github.com/securego/gosec) for checking Go security issues
2727

2828
4. Run project by this command:
2929

3030
```bash
3131
make docker.run
3232
```
3333

34-
5. Go to API Docs page (Swagger): [127.0.0.1:5000/swagger/index.html](http://127.0.0.1:5000/swagger/index.html)
34+
5. Go to API Docs page (Swagger): [0.0.0.0:5000/swagger/index.html](http://0.0.0.0:5000/swagger/index.html)
35+
36+
![Screenshot](https://user-images.githubusercontent.com/11155743/112716623-76bc0800-8ef8-11eb-80db-48edcbdacf36.png)
3537

3638
## 📦 Used packages
3739

3840
| Name | Version | Type |
3941
| --------------------------------------------------------------------- | --------- | ---------- |
40-
| [net/http](https://golang.org/pkg/net/http/) | `v1.16.0` | core |
42+
| [net/http](https://golang.org/pkg/net/http/) | `v1.16.2` | core |
4143
| [auth0/go-jwt-middleware](https://github.com/auth0/go-jwt-middleware) | `v1.0.0` | middleware |
4244
| [swaggo/http-swagger](https://github.com/swaggo/http-swagger) | `v1.0.0` | middleware |
4345
| [stretchr/testify](https://github.com/stretchr/testify) | `v1.7.0` | tests |
4446
| [dgrijalva/jwt-go](https://github.com/dgrijalva/jwt-go) | `v3.2.0` | auth |
4547
| [joho/godotenv](https://github.com/joho/godotenv) | `v1.3.0` | config |
4648
| [jmoiron/sqlx](https://github.com/jmoiron/sqlx) | `v1.3.1` | database |
47-
| [jackc/pgx](https://github.com/jackc/pgx) | `v4.10.1` | database |
49+
| [jackc/pgx](https://github.com/jackc/pgx) | `v4.11.0` | database |
4850
| [swaggo/swag](https://github.com/swaggo/swag) | `v1.7.0` | utils |
4951
| [google/uuid](https://github.com/google/uuid) | `v1.2.0` | utils |
5052
| [go-playground/validator](https://github.com/go-playground/validator) | `v10.4.1` | utils |
@@ -107,4 +109,4 @@ SMTP_PORT=25
107109

108110
## ⚠️ License
109111

110-
MIT &copy; [Vic Shóstak](https://github.com/koddr) & [True web artisans](https://1wa.co/).
112+
Apache 2.0 &copy; [Vic Shóstak](https://shostak.dev/) & [True web artisans](https://1wa.co/).

‎app/controllers/user_controller.go‎

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ import (
1616
// GetUsers func gets all exists users.
1717
// @Description Get all exists users.
1818
// @Summary get all exists users
19-
// @Tags Public
19+
// @Tags Users
2020
// @Accept json
2121
// @Produce json
2222
// @Success 200 {array} models.User
23-
// @Router /api/public/users [get]
23+
// @Router /v1/users [get]
2424
func GetUsers(w http.ResponseWriter, r *http.Request) {
2525
// Define content type.
2626
w.Header().Set("Content-Type", "application/json")
@@ -64,12 +64,12 @@ func GetUsers(w http.ResponseWriter, r *http.Request) {
6464
// GetUser func gets one user by given ID or 404 error.
6565
// @Description Get user by given ID.
6666
// @Summary get user by given ID
67-
// @Tags Public
67+
// @Tags User
6868
// @Accept json
6969
// @Produce json
7070
// @Param id path string true "User ID"
7171
// @Success 200 {object} models.User
72-
// @Router /api/public/user/{id} [get]
72+
// @Router /v1/user/{id} [get]
7373
func GetUser(w http.ResponseWriter, r *http.Request) {
7474
// Define content type and CORS.
7575
w.Header().Set("Content-Type", "application/json")
@@ -124,12 +124,13 @@ func GetUser(w http.ResponseWriter, r *http.Request) {
124124
// CreateUser func for creates a new user.
125125
// @Description Create a new user.
126126
// @Summary create a new user
127-
// @Tags Private
127+
// @Tags User
128128
// @Accept json
129129
// @Produce json
130130
// @Param email body string true "E-mail"
131131
// @Success 200 {object} models.User
132-
// @Router /api/private/user [post]
132+
// @Security ApiKeyAuth
133+
// @Router /v1/user [post]
133134
func CreateUser(w http.ResponseWriter, r *http.Request) {
134135
// Define content type and CORS.
135136
w.Header().Set("Content-Type", "application/json")
@@ -230,12 +231,15 @@ func CreateUser(w http.ResponseWriter, r *http.Request) {
230231
// UpdateUser func for updates user by given ID.
231232
// @Description Update user.
232233
// @Summary update user
233-
// @Tags Private
234+
// @Tags User
234235
// @Accept json
235236
// @Produce json
236237
// @Param id body string true "User ID"
238+
// @Param user_status body integer true "User status"
239+
// @Param user_attrs body models.UserAttrs true "User attributes"
237240
// @Success 200 {object} models.User
238-
// @Router /api/private/user [patch]
241+
// @Security ApiKeyAuth
242+
// @Router /v1/user [put]
239243
func UpdateUser(w http.ResponseWriter, r *http.Request) {
240244
// Define content type and CORS.
241245
w.Header().Set("Content-Type", "application/json")
@@ -343,12 +347,13 @@ func UpdateUser(w http.ResponseWriter, r *http.Request) {
343347
// DeleteUser func for deletes user by given ID.
344348
// @Description Delete user by given ID.
345349
// @Summary delete user by given ID
346-
// @Tags Private
350+
// @Tags User
347351
// @Accept json
348352
// @Produce json
349353
// @Param id body string true "User ID"
350354
// @Success 200 {string} string "ok"
351-
// @Router /api/private/user [delete]
355+
// @Security ApiKeyAuth
356+
// @Router /v1/user [delete]
352357
func DeleteUser(w http.ResponseWriter, r *http.Request) {
353358
// Define content type and CORS.
354359
w.Header().Set("Content-Type", "application/json")

0 commit comments

Comments
 (0)