# wfrest

**Repository Path**: giserlyt/wfrest

## Basic Information

- **Project Name**: wfrest
- **Description**: C++ Web Framework REST API
- **Primary Language**: C++
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 7
- **Created**: 2023-06-23
- **Last Updated**: 2023-06-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ✨ wfrest: C++ Web Framework REST API

wfrest是一个快速🚀, 高效⌛️, 简单易用的💥 c++ 异步web框架.

wfrest基于[✨**C++ Workflow**✨](https://github.com/sogou/workflow)开发. [**C++ Workflow**](https://github.com/sogou/workflow) 是一个设计轻盈优雅的企业级程序引擎.

你可以用来：

- 快速搭建http服务器：

```cpp
#include "wfrest/HttpServer.h"
using namespace wfrest;

int main()
{
    HttpServer svr;

    svr.GET("/hello", [](const HttpReq *req, HttpResp *resp)
    {
        resp->String("world\n");
    });

    if (svr.start(8888) == 0)
    {
        getchar();
        svr.stop();
    } else
    {
        fprintf(stderr, "Cannot start server");
        exit(1);
    }
    return 0;
}
```

## 文档

- [API 示例](#🎆-api-examples)
    - [路由中的参数](./docs/cn/param_in_path.md)
    - [url请求参数](./docs/cn/query_param.md)
    - [表单数据](./docs/cn/post_form.md)
    - [Http头部字段](./docs/cn/header.md)
    - [发送文件](./docs/cn/send_file.md)
    - [保存文件](./docs/cn/save_file.md)
    - [上传文件](./docs/cn/upload_file.md)
    - [Json](./docs/cn/json.md)
    - [计算型Handler](./docs/cn/compute_handler.md)
    - [Series Handler](./docs/cn/series_handler.md)
    - [压缩算法](./docs/cn/compress.md)
    - [蓝图](./docs/cn/blueprint.md)
    - [静态文件服务](./docs/cn/serving_static_file.md)
    - [Cookie](./docs/cn/cookie.md)
    - [配置](./docs/cn/config.md)
    - [面向切面编程](./docs/cn/aop.md)
    - [Https 服务器](./docs/cn/https.md)
    - [代理服务器](./docs/cn/proxy.md)
- [MySQL](./docs/cn/mysql.md)
- [Redis](./docs/cn/redis.md)


## 编译 && 安装

### 需求

* workflow, 版本大于等于 v0.9.9 
* Linux , 比如ubuntu 18.04 或者更新版本
* Cmake
* zlib1g-dev
* libssl-dev
* libgtest-dev
* gcc 和 g++ 或者 llvm + clang

如果你在ubuntu 20.04，你可以用以下命令安装

```bash
apt-get install build-essential cmake zlib1g-dev libssl-dev libgtest-dev -y
```

### cmake

```
git clone --recursive https://github.com/wfrest/wfrest
cd wfrest
make
sudo make install
```

编译例子:

```
make example
```

测试:

```
make check
```

### Docker

```
docker build -t wfrest ./docker/ubuntu/
```

如果你用`podman`

```
podman build -t wfrest ./docker/ubuntu/
```

你也可以从dockerhub中拖拉镜像

```
docker pull wfrest/wfrest
```

# 使用中有疑问？

可以先查看[Discussions](https://github.com/wfrest/wfrest/discussions)和[issues](https://github.com/wfrest/wfrest/issues)列表，看看是否能找到答案。

非常欢迎将您使用中遇到的问题发送到issues。

也可以通过QQ群：884394197 联系我们。