DEV Community


Posted on

Example 3, Automatically generate generic web service (gin) project code, increasing development efficiency by at least 1x

CRUD API interface code generation tools are relatively mature, CRUD code is standardized fixed, relatively easy to generate, for any custom API interface code, should be many developers or manual writing, these are not standardized interface code, how should it be generated?

The solution here is to use the protobuf protocol to describe the api interface, and generate any api interface code of the web service through the protoc plug-in protoc-gen-go-gin.


After installing the tool sponge, execute the command to open the UI interface:

sponge run
Enter fullscreen mode Exit fullscreen mode

Quickly Create a Web Project

Enter the UI interface of sponge, click 【Protobuf】→【Create Web Project】in the left menu bar, and fill in some parameters to generate the web service project code.

Image description

The web framework uses gin. It also includes swagger documents, common service governance function codes, and build and deployment scripts. You can choose which database to use.

Change to the web directory and execute the command:

# Generate code
make proto

# Open the internal/handler/user.go code file and fill in the specific logic code according to the generated template code. 

# compile and start web services
make run 
Enter fullscreen mode Exit fullscreen mode

Open http://localhost:8080/apis/swagger/index.html in your browser to test the API.

Image description

This is the generic web service code generated from the above steps

You can automatically add CRUD api interfaces and manually add custom api interfaces to the generated generic web service code, see the detailed documentation for developing generic web services

Top comments (0)