README.md

Easy Note

Introduction

A simple note service built with Kitex and Hertz which is divided into three microservices.

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

Call Relations

Basic Features

• Hertz
  • Use thrift IDL to define HTTP interface
  • Use hz to generate code
  • Use Hertz binding and validate
  • Use obs-opentelemetry and jarger for tracing, metrics, logging
  • Middleware
    • Use requestid, jwt, recovery, pprof, gzip
• Kitex
  • Use thrift IDL to define RPC interface
  • Use kitex to generate code
  • Use thrift-gen-validator for validating RPC request
  • Use obs-opentelemetry and jarger for tracing, metrics, logging
  • Use registry-etcd for service discovery and register

Catalog Introduce

catalog	introduce
handler	HTTP handler
service	business logic
rpc	RPC call logic
dal	DB operation
pack	data pack
pkg/mw	RPC middleware
pkg/consts	constants
pkg/errno	customized error number
pkg/configs	SQL and Tracing configs

Quick Start

Setup Basic Dependence

docker-compose up

Run User RPC Server

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

Run Note RPC Server

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

Run API Server

cd cmd/api
go run .

Jaeger

Visit http://127.0.0.1:16686/ on browser

Snapshots

Grafana

Visit http://127.0.0.1:3000/ on browser

Dashboard Example

API Requests

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

Register

curl --location --request POST '127.0.0.1:8080/v2/user/register' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username":"lorain",
    "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/v2/user/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username":"lorain",
    "password":"123456"
}'

response

// successful
{
    "code": 0,
    "expire": "2022-12-3T01: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/v2/note' \
--header 'Authorization: Bearer $token' \
--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_key=test' \
--header 'Authorization: Bearer $token'

response

// successful
{
    "code": 0,
    "message": "Success",
    "data": {
        "notes": [
            {
                "note_id": 1,
                "user_id": 1,
                "username": "lorain",
                "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/v2/note/$note_id' \
--header 'Authorization: Bearer $token' \
--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/v2/note/$note_id' \
--header 'Authorization: Bearer $token'

response

// successful
{
    "code": 0,
    "message": "Success",
    "data": null
}

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