REST API endpoint generation using github.com/brocaar/chirpstack-api/go

pooja.mittal · December 11, 2019, 7:03am

Hi @brocaar,
I did all of the steps as above but I did not see the modified changes being reflected in the localhost:8080/api.

A little digging led me towards chirpstack-application-server/Makefile in which:

github.com

brocaar/chirpstack-application-server/blob/60a18ca6b608021391aa0eed3923a9da2318fe8b/Makefile#L53


	@mv ui/build/* static


internal/statics internal/migrations: static/swagger/api.swagger.json
	@echo "Generating static files"
	@go generate internal/migrations/migrations.go
	@go generate internal/static/static.go




static/swagger/api.swagger.json:
	@echo "Fetching Swagger definitions and generate combined Swagger JSON"
	@rm -rf /tmp/chirpstack-api
	@git clone https://github.com/brocaar/chirpstack-api.git /tmp/chirpstack-api
	@git --git-dir=/tmp/chirpstack-api/.git --work-tree=/tmp/chirpstack-api checkout $(API_VERSION)
	@mkdir -p static/swagger
	@cp /tmp/chirpstack-api/swagger/as/external/api/*.json static/swagger
	@GOOS="" GOARCH="" go run internal/tools/swagger/main.go /tmp/chirpstack-api/swagger/as/external/api > static/swagger/api.swagger.json


# shortcuts for development


dev-requirements:
	go mod download

While building:

It is first removing the /tmp/chirpstack-api
Performing a fresh clone of the same from the github repository in /tmp
After that it copies the generated swagger definitions in static/swagger

Since I wanted my modified swagger definitions to show inside static/swagger and not the freshly cloned ones, I commented lines : 53, 54, and 55 in the Makefile.

After that I updated the .proto definitions in the /tmp/chirpstack-api repository.
Then, re-generated the chirpstack-api Go & Swagger code using make go & make all.
Built the chirpstack-application-server using make clean build.
The modified changes reflected at localhost:8080/api.

Previously, I only had to make modifications inside in the .proto definitions inside /api and see the reflected changes after using make api and make clean build, in chirpstack-application-server.

Now, is it necessary to perform all of the above mentioned steps every time I make any change in the proto definitions? or is there any other way round?