# free-api

**Repository Path**: oshine/free-api

## Basic Information

- **Project Name**: free-api
- **Description**: Murphy框架官方用例
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-07-28
- **Last Updated**: 2024-08-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: murphy

## README

# FreeApi   ❤️ by Oshine

>使用golang基于go-murphy框架开发的供所有人免费测试使用的api项目。

## 1.)注意事项
> 1.本项目采用 murphy 开发的 webapi，启动时需要遵守其对应规则\
> 2.注意本项目运行必须安装 redis ssdb\
> 3.根据框架协议 app/internal 中的所有内容为自动生成，不可以手动修改


## 2.)构建项目
**1.项目中的`.env`文件正常时不能随项目一起发布，这里防止刚入门的同学不知如何配置.env文件导致项目运行不起来，特地随git发布**

**2.项目运行前需要先把db目录下的`*.sql`数据库结构文件导入到mysql数据库中**

**3.运行前请检查 `db-main.config.yaml` 和 `db-msg-config.yaml` 文件中的数据库配置是否正确,配置文件引用了 `.env` 文件**

**go run --tags mysql main.go**

![run.jpg](run.jpg)

## 3.)Auto工具
安装完成auto工具后，在项目根目录执行：
```shell
auto gen dao      all/table_name      # 数据结构生成命令，all: 执行后遍历所有数据表后生成对应的dao文件， table_name：只生成给定的表对应的dao文件，下方命令行有相同的使用方法
auto gen mod      all/table_name      # 数据表基础模型生成命令
auto gen model    all/table_name      # 数据表模型文件生成命令
auto gen ctl      all/table_name      # 控制器生成命令
```


## 4.)启动
1.构建：
`go build --tags mysql main.go`

2.直接运行：
`go run --tags mysql main.go`

## 5.)已有Api能力
>登录 🆗 \
>用户上传头像 🆗 \
>创建帖子 🆗 \
>删除帖子 🆗 \
>修改帖子 🆗 \
>追加帖子内容 🆗 \
> 

## 6.)已有websocket能力
>登录 🆗 \
>添加好友 🆗 \
>删除好友 🆗 \
>发送好友消息 🆗 \
>