Files
open-im-server/scripts/make-rules/swagger.mk
T

19 lines
756 B
Makefile
Raw Normal View History

2023-07-04 18:25:51 +08:00
# ==============================================================================
# Makefile helper functions for swagger
#
2023-07-04 20:18:39 +08:00
## swagger.run: Generate swagger document.
2023-07-04 18:25:51 +08:00
.PHONY: swagger.run
swagger.run: tools.verify.swagger
@echo "===========> Generating swagger API docs"
2023-07-04 20:18:39 +08:00
@$(TOOLS_DIR)/swagger generate spec --scan-models -w $(ROOT_DIR)/cmd/genswaggertypedocs -o $(ROOT_DIR)/api/swagger/swagger.yaml
2023-07-04 18:25:51 +08:00
2023-07-04 20:18:39 +08:00
## swagger.serve: Serve swagger spec and docs.
2023-07-04 18:25:51 +08:00
.PHONY: swagger.serve
swagger.serve: tools.verify.swagger
2023-07-04 20:18:39 +08:00
@$(TOOLS_DIR)/swagger serve -F=redoc --no-open --port 36666 $(ROOT_DIR)/api/swagger/swagger.yaml
## swagger.help: Display help information about the release package
.PHONY: swagger.help
swagger.help: scripts/make-rules/swagger.mk
$(call smallhelp)