Skip to content

Commit 165728d

Browse files
committed
Merge branch 'develop'
2 parents f416d1e + 2416258 commit 165728d

File tree

14 files changed

+1262
-226
lines changed

14 files changed

+1262
-226
lines changed

Makefile

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.PHONY:
22

3+
### for running all commands we need bash command lien ###
4+
35
## choco install make
46
# ==============================================================================
57
# Run Services
@@ -35,9 +37,9 @@ proto_identities_get_user_by_id_service:
3537
@echo Generating identity_service proto
3638
protoc --go_out=./internal/services/product_service/product/grpc_client/protos --go-grpc_opt=require_unimplemented_servers=false --go-grpc_out=./internal/services/product_service/product/grpc_client/protos ./internal/services/product_service/product/grpc_client/protos/*.proto
3739

38-
## go install github.com/swaggo/swag/cmd/swag@latest
39-
# ==============================================================================
40+
## go install github.com/swaggo/swag/cmd/swag@v1.8.3
4041
# Swagger products Service #https://github.com/swaggo/swag/issues/817
42+
# ==============================================================================
4143

4244
swagger_products:
4345
@echo Starting swagger generating

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,12 @@ go test -v ./...
145145
> ### Documentation Apis
146146
147147

148-
Each microservice has a `Swagger OpenAPI`. Browse to `/swagger` for a list of endpoints.
148+
Each microservice has a `Swagger OpenAPI`. Browse to `/swagger/index.html` for a list of endpoints.
149+
150+
> Note: For generate Swagger OpenAPI, we need to install `swag cli` with this command below:
151+
```bash
152+
go install github.com/swaggo/swag/cmd/swag@v1.8.3
153+
```
149154

150155
As part of API testing, I created the [shop.rest](./shop.rest) file which can be run with the [REST Client](https://github.com/Huachao/vscode-restclient) `VSCode plugin`.
151156

0 commit comments

Comments
 (0)