Simple Example

Take hz tool generated project for example:

generations please refer to hz usage(thrift)

Project Structure:


The file containing the route registration code is as follows:

  • router.go
// Code generated by hertz generator.

package main

import (
	handler ""

// customizeRegister registers customize routers.
func customizedRegister(r *server.Hertz) {
	r.GET("/ping", handler.Ping)

	// your code ...

  • biz/router/hello/example/hello.go
// Code generated by hertz generator. DO NOT EDIT.

package example

import (
	example ""

 This file will register all the routes of the services in the master idl.
 And it will update automatically when you use the "update" command for the idl.
 So don't modify the contents of the file, or your code will be deleted when it is updated.

// Register register routes based on the IDL 'api.${HTTP Method}' annotation.
func Register(r *server.Hertz) {

	root := r.Group("/", rootMw()...)
	root.GET("/hello", append(_hellomethodMw(), example.HelloMethod)...)

Now execute the api-list command in the project root directory

cwgo api-list or cwgo api-list --project_path .

The output is as follows:


Last modified June 26, 2024 : doc: add construct use case (#1098) (83b7cf9)