Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
meysamhadeli committed Apr 6, 2024
2 parents f416d1e + 2416258 commit 165728d
Show file tree
Hide file tree
Showing 14 changed files with 1,262 additions and 226 deletions.
6 changes: 4 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.PHONY:

### for running all commands we need bash command lien ###

## choco install make
# ==============================================================================
# Run Services
Expand Down Expand Up @@ -35,9 +37,9 @@ proto_identities_get_user_by_id_service:
@echo Generating identity_service proto
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

## go install github.com/swaggo/swag/cmd/swag@latest
# ==============================================================================
## go install github.com/swaggo/swag/cmd/[email protected]
# Swagger products Service #https://github.com/swaggo/swag/issues/817
# ==============================================================================

swagger_products:
@echo Starting swagger generating
Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,12 @@ go test -v ./...
> ### Documentation Apis

Each microservice has a `Swagger OpenAPI`. Browse to `/swagger` for a list of endpoints.
Each microservice has a `Swagger OpenAPI`. Browse to `/swagger/index.html` for a list of endpoints.

> Note: For generate Swagger OpenAPI, we need to install `swag cli` with this command below:
```bash
go install github.com/swaggo/swag/cmd/[email protected]
```

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`.

Expand Down
Loading

0 comments on commit 165728d

Please sign in to comment.