Basic

Basic user guide which could operate by user turn on/off by modifying boot.yaml.

Overview

In basic user guide, we will introduce how to enable bellow functionalities by modifying boot.yaml.

Functionality Description
GRPC Gateway Enable grpc-gateway
Swagger UI Enable swagger UI
Common Service Enable common service
RK TV Enable RK TV
Prometheus Client Enable prometheus client
Logging Enable logging middleware
Metrics Enable prometheus middleware
Meta Enable meta middleware
Tracing Enable openTelemetry tracing middleware
Auth Enable basic & ApiKey auth middleware

GRPC Gateway

Enable grpc-gateway.

Swagger UI

Enable swagger UI for server.

Common Service

Enable common service for server.

RK TV

Enable RK TV for server.

Prometheus client

Enable prometheus client for the server.

Interceptor logging

Enable RPC logging interceptor/middleware for server.

Interceptor metrics

Enable RPC metrics interceptor/middleware for server.

Interceptor meta

Enable RPC meta interceptor/middleware for server.

Interceptor rate limit

Enable rate limit interceptor/middleware for the server.

Interceptor tracing

Enable RPC tracing interceptor/middleware for server.

Interceptor auth

Enable RPC auth interceptor/middleware for server.

Interceptor timeout

Enable timeout interceptor/middleware for the server.

Last modified July 12, 2021 : Add chinese version of document (f8db16e)