https://github.com/muxi-studio/guisheng2

the backend of guiSheng app
https://github.com/muxi-studio/guisheng2

Last synced: 1 day ago
JSON representation

the backend of guiSheng app

• Host: GitHub
• URL: https://github.com/muxi-studio/guisheng2
• Owner: Muxi-Studio
• License: other
• Created: 2015-07-12T12:32:04.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-02-20T02:09:31.000Z (over 8 years ago)
• Last Synced: 2024-04-14T13:07:52.582Z (7 months ago)
• Language: HTML
• Homepage:
• Size: 17.5 MB
• Stars: 4
• Watchers: 2
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[开始重构!!!] 


桂声APP后台

===

    桂声APP后台开发版

    测试数据库

    测试API

## Build

### Virtual Environment

    $ virtualenv venv

    $ source venv/bin/activate

### Install Extensions

    $ pip install -r extensions.txt

### Test Database

    $ chmod 777 data.sh

    $ ./data.sh

### Run

    $ python manage.py runserver (--help)

## 桂声API测试版文档

### 1. 预备

#### 测试根url: http://121.43.230.104:5000/api/v1.0/

#### 申请测试账户: 在此仓库的issue下留言，写上基本信息，以及使用这个API的目的

### 2. API验证

#### 1. 验证方式

    桂声API采用token验证(token是包含用户信息的加密签名)

#### 2. 获取token (在终端采用httpie测试)

    http --auth user_email POST http://121.43.230.104:5000/api/v1.0/token

得到token如下

    HTTP/1.0 200 OK

    Content-Length: 162

    Content-Type: application/json

    Date: Tue, 06 Oct 2015 07:30:31 GMT

    Server: Werkzeug/0.10.4 Python/2.7.6

    {

        "expiration": 3600,

        "token": "eyJhbGciOiJIUzI1NiIsImV4cCI6MTQ0NDEyMDIzMSwiaWF0IjoxNDQ0MTE2"

    }

### 3. 具体板块API文档

    桂声APP分为三个板块: 新闻、原创、互动

        新闻: 提供校园咨询

        原创: 提供优质图集、美文

        互动: 与小编互动

[具体板块API文档](https://github.com/neo1218/guisheng2/blob/master/doc/news_api.md) 


### 4. 用户API文档

    用户的基本信息

[用户API文档](https://github.com/neo1218/guisheng2/blob/master/doc/users_api.md) 


### 5. 评论API文档

    评论的信息

[评论API文档](https://github.com/neo1218/guisheng2/blob/master/doc/comments_api.md) 


### 6. API的可寻址性

    这个API文档尽可能做到将所有用到的API资源列举出来，但是更多的资源还可以深入挖掘

    比如获取一篇文章，你可以根据返回的作者的url，进一步获取作者的信息

### 7. issue

    issue #1: 申请测试账号

    issue #5: 用户API issue

    issue #6: 评论API issue

    issue #4: 具体板块API issue

### 8. Test

#### run test use makefile

    make

### 9. LICENSE

    MIT LICENSE

    see LICENSE for more details