Easy Note

Introduction

Add a demo for kitex which implements a simple note service,the demo is divided into three main sections.

Service Name	Usage	Framework	protocol	Path	IDL
demoapi	http interface	kitex/hertz	http	bizdemo/easy_note/cmd/api
demouser	user data management	kitex/gorm	protobuf	bizdemo/easy_note/cmd/user	bizdemo/easy_note/idl/user.proto
demonote	note data management	kitex/gorm	thrift	bizdemo/easy_note/cmd/note	bizdemo/easy_note/idl/note.thrift

call relations

                                    http
                           ┌────────────────────────┐
 ┌─────────────────────────┤                        ├───────────────────────────────┐
 │                         │         demoapi        │                               │
 │      ┌──────────────────►                        │◄──────────────────────┐       │
 │      │                  └───────────▲────────────┘                       │       │
 │      │                              │                                    │       │
 │      │                              │                                    │       │
 │      │                              │                                    │       │
 │      │                           resolve                                 │       │
 │      │                              │                                    │       │
req    resp                            │                                   resp    req
 │      │                              │                                    │       │
 │      │                              │                                    │       │
 │      │                              │                                    │       │
 │      │                   ┌──────────▼─────────┐                          │       │
 │      │                   │                    │                          │       │
 │      │       ┌───────────►       Etcd         ◄─────────────────┐        │       │
 │      │       │           │                    │                 │        │       │
 │      │       │           └────────────────────┘                 │        │       │
 │      │       │                                                  │        │       │
 │      │     register                                           register   │       │
 │      │       │                                                  │        │       │
 │      │       │                                                  │        │       │
 │      │       │                                                  │        │       │
 │      │       │                                                  │        │       │
┌▼──────┴───────┴───┐                                           ┌──┴────────┴───────▼─┐
│                   │───────────────── req ────────────────────►│                     │
│       demonote    │                                           │        demouser     │
│                   │◄──────────────── resp ────────────────────│                     │
└───────────────────┘                                           └─────────────────────┘
      thrift                                                           protobuf

Use Basic Features

• Middleware、Rate Limiting、Request Retry、Timeout Control、Connection Multiplexing
• Tracing
  • use jaeger to tracing
• Customized BoundHandler
  • achieve CPU utilization rate customized bound handler
• Service Discovery and Register
  • use registry-etcd to discovery and register service

catalog introduce

catalog	introduce
pkg/constants	constant
pkg/bound	customized bound handler
pkg/errno	customized error number
pkg/middleware	RPC middleware
pkg/tracer	init jaeger
dal	db operation
pack	data pack
service	business logic

Quick Start

1.Setup Basic Dependence

docker-compose up

2.Run Note RPC Server

cd cmd/note
sh build.sh
sh output/bootstrap.sh

3.Run User RPC Server

cd cmd/user
sh build.sh
sh output/bootstrap.sh

4.Run API Server

cd cmd/api
chmod +x run.sh
./run.sh

5.Jaeger

visit http://127.0.0.1:16686/ on browser.

Snapshots

Custom Error Code

Customise the response error code in the errno package.

const (
    SuccessCode                = 0
    ServiceErrCode             = 10001
    ParamErrCode               = 10002
    UserAlreadyExistErrCode    = 10003
    AuthorizationFailedErrCode = 10004
)

Sample code : Replace the default error code for hertz-jwt authentication error with a custom error code.

authMiddleware, _ := jwt.New(&jwt.HertzJWTMiddleware{
    Unauthorized: func(ctx context.Context, c *app.RequestContext, code int, message string) {
        c.JSON(code, map[string]interface{}{
            "code":    errno.AuthorizationFailedErrCode,
            "message": message,
        })
    },
    //Unauthorized: func(ctx context.Context, c *app.RequestContext, code int, message string) {
    //  c.JSON(code, map[string]interface{}{
    //      "code":    code,
    //      "message": message,
    //  })
    //}
})

API requests

The following is a list of API requests and partial responses.

Register

curl --location --request POST '127.0.0.1:8080/v1/user/register' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username":"kinggo",
    "password":"123456"
}'

response

// successful
{
    "code": 0,
    "message": "Success",
    "data": null
}
// failed
{
    "code": 10003,
    "message": "User already exists",
    "data": null
}

Login

will return jwt token

curl --location --request POST '127.0.0.1:8080/v1/user/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username":"kinggo",
    "password":"123456"
}'

response

// successful
{
    "code": 0,
    "expire": "2022-01-19T01:56:46+08:00",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2NDI1Mjg2MDYsImlkIjoxLCJvcmlnX2lhdCI6MTY0MjUyNTAwNn0.k7Ah9G4Enap9YiDP_rKr5HSzF-fc3cIxwMZAGeOySqU"
}
// failed
{
    "code": 10004,
    "message": "Authorization failed",
    "data": null
}

Create Note

curl --location --request POST '127.0.0.1:8080/v1/note' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2NzcyMzM3NDAsImlkIjoxLCJvcmlnX2lhdCI6MTY3NzIxMjE0MH0.ZsRqWyChL0ifazRk4m-xRR2XAMV-u8HtyVuKXwya0S4' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title":"test title",
    "content":"test content"
}'

response

// successful
{
    "code": 0,
    "message": "Success",
    "data": null
}
// failed
{
    "code": 10002,
    "message": "Wrong Parameter has been given",
    "data": null
}

Query Note

curl --location --request GET '127.0.0.1:8080/v1/note/query?offset=0&limit=20&search_keyword=test' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2NzcyMzM3NDAsImlkIjoxLCJvcmlnX2lhdCI6MTY3NzIxMjE0MH0.ZsRqWyChL0ifazRk4m-xRR2XAMV-u8HtyVuKXwya0S4'

response

// successul
{
    "code": 0,
    "message": "Success",
    "data": {
        "notes": [
            {
                "note_id": 1,
                "user_id": 1,
                "user_name": "kinggo",
                "user_avatar": "test",
                "title": "test title",
                "content": "test content",
                "create_time": 1642525063
            }
        ],
        "total": 1
    }
}
// failed
{
    "code":10002,
    "message":"Wrong Parameter has been given",
    "data":null
}

Update Note

curl --location --request PUT '127.0.0.1:8080/v1/note/$note_id' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2NzcyMzM3NDAsImlkIjoxLCJvcmlnX2lhdCI6MTY3NzIxMjE0MH0.ZsRqWyChL0ifazRk4m-xRR2XAMV-u8HtyVuKXwya0S4' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title":"test",
    "content":"test"
}'

response

// successful
{
    "code": 0,
    "message": "Success",
    "data": null
}
// failed
{
    "code":10001,
    "message":"strconv.ParseInt: parsing \"$note_id\": invalid syntax",
    "data":null
}

Delete Note

curl --location --request DELETE '127.0.0.1:8080/v1/note/$note_id' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2NzcyMzM3NDAsImlkIjoxLCJvcmlnX2lhdCI6MTY3NzIxMjE0MH0.ZsRqWyChL0ifazRk4m-xRR2XAMV-u8HtyVuKXwya0S4'

response

// successful
{
    "code": 0,
    "message": "Success",
    "data": null
}
// failed
{
    "code":10001,
    "message":"strconv.ParseInt: parsing \"$note_id\": invalid syntax",
    "data":null
}