example
This commit is contained in:
31
example/clients/go/docs/GreetApi.md
Normal file
31
example/clients/go/docs/GreetApi.md
Normal file
@ -0,0 +1,31 @@
|
||||
# \GreetApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**Ping**](GreetApi.md#Ping) | **Get** /user/ping |
|
||||
|
||||
|
||||
# **Ping**
|
||||
> interface{} Ping(ctx, )
|
||||
|
||||
|
||||
### Required Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### 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)
|
||||
|
11
example/clients/go/docs/LoginReq.md
Normal file
11
example/clients/go/docs/LoginReq.md
Normal file
@ -0,0 +1,11 @@
|
||||
# LoginReq
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Username** | **string** | | [optional] [default to null]
|
||||
**Password** | **string** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
12
example/clients/go/docs/RegisterReq.md
Normal file
12
example/clients/go/docs/RegisterReq.md
Normal file
@ -0,0 +1,12 @@
|
||||
# RegisterReq
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Username** | **string** | | [optional] [default to null]
|
||||
**Password** | **string** | | [optional] [default to null]
|
||||
**Mobile** | **string** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
119
example/clients/go/docs/UserApiApi.md
Normal file
119
example/clients/go/docs/UserApiApi.md
Normal file
@ -0,0 +1,119 @@
|
||||
# \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)
|
||||
|
14
example/clients/go/docs/UserInfoReply.md
Normal file
14
example/clients/go/docs/UserInfoReply.md
Normal file
@ -0,0 +1,14 @@
|
||||
# UserInfoReply
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **string** | | [optional] [default to null]
|
||||
**Age** | **int32** | | [optional] [default to null]
|
||||
**Birthday** | **string** | | [optional] [default to null]
|
||||
**Description** | **string** | | [optional] [default to null]
|
||||
**Tag** | **[]string** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
10
example/clients/go/docs/UserInfoReq.md
Normal file
10
example/clients/go/docs/UserInfoReq.md
Normal file
@ -0,0 +1,10 @@
|
||||
# UserInfoReq
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **string** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
10
example/clients/go/docs/UserSearchReply.md
Normal file
10
example/clients/go/docs/UserSearchReply.md
Normal file
@ -0,0 +1,10 @@
|
||||
# UserSearchReply
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**KeyWord** | [**[]UserInfoReply**](UserInfoReply.md) | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
10
example/clients/go/docs/UserSearchReq.md
Normal file
10
example/clients/go/docs/UserSearchReq.md
Normal file
@ -0,0 +1,10 @@
|
||||
# UserSearchReq
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**KeyWord** | **string** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
Reference in New Issue
Block a user