跳转到主要内容

只需一行代码即可为您的Django项目创建API!

项目描述

![简单!](http://i.imgur.com/LQujlwt.png)

django-easy-api
===============

**django_easy_api** 允许您通过仅更改一行代码来为Django项目创建API!

使用 **django_easy_api** 最简单的方法是简单地替换 render_to_response

```python
# from django.shortcuts import render_to_response
from easy_api.shortcuts import render_to_response
```

因此,如果这返回一个渲染的HTML视图

http://yoursite.com/item/23

那么这返回同一页面的JSON序列化视图

http://yoursite.com/item/23?api=json

然后这返回同一页面的XML序列化视图

http://yoursite.com/item/23?api=xml

太棒了!您实际上不需要做任何事情。

#### 安装

0. 安装 django-easy-split

```python
pip install django-easy-api
```

1. 将 'easy_api' 添加到您的 INSTALLED_APPS 设置中,如下所示

```python
INSTALLED_APPS = (
...
'easy_api',
)
```

## 使用方法

使用 **django_easy_api** 最简单的方法是简单地替换 render_to_response

```python
# from django.shortcuts import render_to_response
from easy_api.shortcuts import render_to_response
```

现在,您所有的视图都将有API版本!

如果您只想为某些视图使用 **django_easy_api**,则可以显式使用它

```python
from easy_api.shortcuts import render_to_easy_api_response
```
然后在您的视图中使用它而不是 render_to_response。

## 备注

好吧,好吧,所以它不是完整的API。它仅适用于GET。如果您需要功能齐全的API,请查看 [Django-Rest-Framework](https://django-rest-framework.django.ac.cn/)。然而,如果您只需要网站的可读版本,这将是最简单的方法!

### TODO

* 我不知道它对ForeignKeys有什么影响。待测试!
* 我尚未在生产环境中测试此功能,但它应该可以正常工作。

项目详情


由以下机构支持