interfaces

Documentation

Overview

@tg version=0.0.0 @tg title=`Example API` @tg description=`A service which provide Example API` @tg servers=`http://example.test` @tg packageJSON=`github.com/seniorGolang/json` @tg http-prefix=api/v1

Index

• type ExampleRPC
• type User

Types

type ExampleRPC

type ExampleRPC interface {

	// @tg summary=`json RPC метод`
	// @tg arg1.type=string
	// @tg arg1.format=uuid
	// @tg http-headers=arg0|X-Arg
	Test(ctx context.Context, arg0 int, arg1 string, opts ...interface{}) (ret1 int, ret2 string, err error)
	Test2(ctx context.Context, arg0 int, arg1 string, opts ...interface{}) (ret1 int, ret2 string, err error)
}

@tg jsonRPC-server log metrics trace

type User

type User interface {

	// @tg summary=`Данные пользователя`
	// @tg desc=`Возвращает данные пользователя код успеха 204`
	// @tg http-method=GET
	// @tg http-success=204
	// @tg http-path=/user/info
	// @tg http-cookies=cookie|sessionCookie
	// @tg http-headers=userAgent|User-Agent
	// @tg 401=github.com/seniorGolang/tg/v2/example/error:ErrorType
	GetUser(ctx context.Context, cookie, userAgent string) (user *types.User, err error)

	// @tg summary=`Метод со сторонним обработчиком ответа`
	// @tg http-method=PATCH
	// @tg http-path=/user/custom/response
	// @tg http-response=github.com/seniorGolang/tg/v2/example/implement:CustomResponseHandler
	CustomResponse(ctx context.Context, arg0 int, arg1 string, opts ...interface{}) (err error)

	// @tg summary=`Метод полностью обрабатываемый кастомным хендлером`
	// @tg http-method=DELETE
	// @tg http-path=/user/custom
	// @tg handler=github.com/seniorGolang/tg/v2/example/implement:CustomHandler
	CustomHandler(ctx context.Context, arg0 int, arg1 string, opts ...interface{}) (err error)
}

@tg http-prefix=api/v2 @tg http-server log metrics trace общий код 400 для всех методов, кроме UploadFile @tg 400=github.com/seniorGolang/tg/v2/example/error:ErrorType