59 lines
1.8 KiB
Markdown
59 lines
1.8 KiB
Markdown
# Go API client for swagger
|
|
|
|
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
|
|
|
## Overview
|
|
This API client was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project. By using the [swagger-spec](https://github.com/swagger-api/swagger-spec) from a remote server, you can easily generate an API client.
|
|
|
|
- API version:
|
|
- Package version: 1.0.0
|
|
- Build package: io.swagger.codegen.languages.GoClientCodegen
|
|
|
|
## Installation
|
|
Put the package under your project folder and add the following in import:
|
|
```golang
|
|
import "./swagger"
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *http://localhost*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*GreetApi* | [**Ping**](docs/GreetApi.md#ping) | **Get** /user/ping |
|
|
*UserApiApi* | [**GetUserInfo**](docs/UserApiApi.md#getuserinfo) | **Get** /api/user/{id} | 获取用户信息
|
|
*UserApiApi* | [**Login**](docs/UserApiApi.md#login) | **Post** /api/user/login | 登录
|
|
*UserApiApi* | [**Register**](docs/UserApiApi.md#register) | **Post** /api/user/register | 注册
|
|
*UserApiApi* | [**SearchUser**](docs/UserApiApi.md#searchuser) | **Get** /api/user/search | 用户搜索
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
- [LoginReq](docs/LoginReq.md)
|
|
- [RegisterReq](docs/RegisterReq.md)
|
|
- [UserInfoReply](docs/UserInfoReply.md)
|
|
- [UserInfoReq](docs/UserInfoReq.md)
|
|
- [UserSearchReply](docs/UserSearchReply.md)
|
|
- [UserSearchReq](docs/UserSearchReq.md)
|
|
|
|
|
|
## Documentation For Authorization
|
|
|
|
## apiKey
|
|
- **Type**: API key
|
|
|
|
Example
|
|
```golang
|
|
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
|
|
Key: "APIKEY",
|
|
Prefix: "Bearer", // Omit if not necessary.
|
|
})
|
|
r, err := client.Service.Operation(auth, args)
|
|
```
|
|
|
|
## Author
|
|
|
|
|
|
|