# sanic_rest_framework

**Repository Path**: let_alone_the_wind/sanic_rest_framework

## Basic Information

- **Project Name**: sanic_rest_framework
- **Description**: Source of inspiration DjangoRestFramework 
基于Sanic的rest api插件，集大成之作，长期维护。
- **Primary Language**: Python
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2021-12-07
- **Last Updated**: 2021-12-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# sanic_rest_framework 框架文档

## 发起项目原因

起初因公司项目原因知道了Sanic这个小巧又快捷可控性又高的web框架，但是由于其生态不够完善插件较少，现存的很多框架插件都是外国人开发的不符合国内情况，于是就萌生了为其开发一个框架的念头，再三考虑后决定开发一个类似于 django-rest-framework 的框架，于是就有了这个开源项目SRF，内部接口及对应的函数也与DRF大同小异,熟悉DRF者可以快速上手SRF

## 大致流程图

```sequence
Title: SRF处理数据的基础流程
User->Web Server: 用户发起请求
Web Server->View: 异步处理请求
View->View: 通过`dispatch`分发请求并处理
View->serializers: 传入待验证的数据进行处理
serializers->View: 传出验证结果及处理后的数据
View->Web Server: 处理数据curd
Web Server->User: 输出 Json Or Raw 
```

### 最小样例

①、安装sanic_rest_framework

`pip install sanic`

`pip install tortoise-orm`

`pip install sanic_rest_framework`

②、运行如下代码

##### Model.py

```python
from tortoise import Model, fields

class UserModel(Model):
    id = fields.IntField(pk=True)
    name = fields.CharField(50)

    def __str__(self):
        return f"User {self.id}: {self.name}"
```

##### Main.py

```python
import logging

from models import UserModel
from sanic import Sanic, response
from sanic_rest_framework.request import SRFRequest
from sanic_rest_framework.routes import ViewSetRouter
from sanic_rest_framework.serializers import ModelSerializer
from sanic_rest_framework.views import ModelViewSet
from tortoise import Model, fields
from tortoise.contrib.sanic import register_tortoise

logging.basicConfig(level=logging.DEBUG)
app = Sanic(__name__, request_class=SRFRequest)


class UserSerializer(ModelSerializer):
    class Meta:
        model = UserModel
        read_only_fields = ('id')


class TestView(ModelViewSet):
    serializer_class = UserSerializer
    queryset = UserModel
    search_fields = ('@question',)


route = ViewSetRouter()
route.register(TestView, '/TestView', 'test', True)
for i in route.urls:
    i.pop('is_base')
    app.add_route(**i)

register_tortoise(
    app, db_url="sqlite://:memory:", modules={"models": ['models']}, generate_schemas=True
)

if __name__ == "__main__":
    app.run(port=5000)

```

##### 访问 <http://127.0.0.1:5000/TestView> 即可看到运行结果 可以使用 PostMan 发起Post等请求

```json
// 结果如下
{
    "data": {
        "count": 0,
        "next": null,
        "next_page_num": null,
        "previous": null,
        "previous_num": 0,
        "results": []
    },
    "message": "Success",
    "status": 1
}
```