120 lines
3.3 KiB
Markdown
120 lines
3.3 KiB
Markdown
|
# \UserApiApi
|
||
|
|
|
||
|
|
All URIs are relative to *http://localhost*
|
||
|
|
|
||
|
|
Method | HTTP request | Description
|
||
|
|
------------- | ------------- | -------------
|
||
|
|
[**GetUserInfo**](UserApiApi.md#GetUserInfo) | **Get** /api/user/{id} | 获取用户信息
|
||
|
|
[**Login**](UserApiApi.md#Login) | **Post** /api/user/login | 登录
|
||
|
|
[**Register**](UserApiApi.md#Register) | **Post** /api/user/register | 注册
|
||
|
|
[**SearchUser**](UserApiApi.md#SearchUser) | **Get** /api/user/search | 用户搜索
|
||
|
|
|
||
|
|
|
||
|
|
# **GetUserInfo**
|
||
|
|
> UserInfoReply GetUserInfo(ctx, id, body)
|
||
|
|
获取用户信息
|
||
|
|
|
||
|
|
### Required Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||
|
|
**id** | **string**| |
|
||
|
|
**body** | [**UserInfoReq**](UserInfoReq.md)| |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**UserInfoReply**](UserInfoReply.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
No authorization required
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: application/json
|
||
|
|
- **Accept**: application/json
|
||
|
|
|
||
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||
|
|
|
||
|
|
# **Login**
|
||
|
|
> interface{} Login(ctx, body)
|
||
|
|
登录
|
||
|
|
|
||
|
|
### Required Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||
|
|
**body** | [**LoginReq**](LoginReq.md)| |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**interface{}**](interface{}.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
No authorization required
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: application/json
|
||
|
|
- **Accept**: application/json
|
||
|
|
|
||
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||
|
|
|
||
|
|
# **Register**
|
||
|
|
> interface{} Register(ctx, body)
|
||
|
|
注册
|
||
|
|
|
||
|
|
注册一个用户
|
||
|
|
|
||
|
|
### Required Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||
|
|
**body** | [**RegisterReq**](RegisterReq.md)| |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**interface{}**](interface{}.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
No authorization required
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: application/json
|
||
|
|
- **Accept**: application/json
|
||
|
|
|
||
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||
|
|
|
||
|
|
# **SearchUser**
|
||
|
|
> UserSearchReply SearchUser(ctx, body)
|
||
|
|
用户搜索
|
||
|
|
|
||
|
|
### Required Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||
|
|
**body** | [**UserSearchReq**](UserSearchReq.md)| |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**UserSearchReply**](UserSearchReply.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
No authorization required
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: application/json
|
||
|
|
- **Accept**: application/json
|
||
|
|
|
||
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||
|
|
|