Skip to content

同步代码 #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TommyLemon merged 4 commits into from
Dec 14, 2018
Merged

同步代码 #1

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3f75150
refractor apijson models settings, add apijson style roles
zhangchunlin Dec 14, 2018
14d8d16
refactor _get_array to new apijson model settings
zhangchunlin Dec 14, 2018
6eed78b
update document and screenshot
zhangchunlin Dec 14, 2018
ef703f3
fix document
zhangchunlin Dec 14, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
update document and screenshot
  • Loading branch information
@zhangchunlin
zhangchunlin committed Dec 14, 2018
commit 6eed78ba8e69a2b0187b27e337b2df1c69b71483
Binary file modified demo/doc/imgs/demo_screenshot.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
168 changes: 9 additions & 159 deletions uliweb_apijson/apijson/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,174 +9,24 @@ uliweb-apijson is a subset and slightly different variation of [apijson](https:/
```
[APIJSON_MODEL_CONFIG]
user = {
"public" : False,
"user_id_field" : "id",
"secret_fields" : ["password"],
"default_filter_by_self" : True
"rbac_get" : {
"roles" : ["ADMIN","OWNER"]
}
}
```

## document

settings.APIJSON_MODEL_CONFIG.[MODEL_NAME]

| Field | Doc |
| ---------------------- | ------------------------------------------------------------ |
| public | Default to be "False".<br />If not public, should be **login user** and only can see **user own data**. |
| user_id_field | Field name of user id, related to query user own data. |
| secret_fields | Secret fields won't be exposed. |
| default_filter_by_self | If True, when no filter parameter, will filter by self user id |
| Field | Doc |
| ------------- | ---------------------------------------------------------- |
| user_id_field | Field name of user id, related to query user own data. |
| secret_fields | Secret fields won't be exposed. |
| rbac_get | Configure of roles or permissions for apijson 'get' method |

# Supported API Examples

### Single record query: with id as parameter

URL: apijson/get

Method: POST

Request:

```
{
"user":{
"id":1
}
}
```

Response:

```
{
"code": 200,
"msg": "success",
"user": {
"username": "usera",
"nickname": "User A",
"email": "usera@localhost",
"is_superuser": false,
"last_login": null,
"date_join": "2018-12-05 15:44:26",
"image": "",
"active": false,
"locked": false,
"deleted": false,
"auth_type": "default",
"id": 1
}
}
```

### Single record query: no parameter

URL: apijson/get

Method: POST

Request:

```
{
"user":{
}
}
```

Response:

```
{
"code": 200,
"msg": "success",
"user": {
"username": "usera",
"nickname": "User A",
"email": "usera@localhost",
"is_superuser": false,
"last_login": null,
"date_join": "2018-12-05 15:44:26",
"image": "",
"active": false,
"locked": false,
"deleted": false,
"auth_type": "default",
"id": 1
}
}
```

### Single record query: @column

URL: apijson/get

Method: POST

Request:

```
{
"user":{
"@column": "id,username,email"
}
}
```

Response:

```
{
"code": 200,
"msg": "success",
"user": {
"username": "usera",
"email": "usera@localhost",
"id": 1
}
}
```

### Array query

URL: apijson/get

Method: POST

Request:

```
{
"[]":{
"@count":2,
"@page":0,
"user":{
"@column":"id,username,nickname,email",
"@order":"id-"
}
}
}
```

Response:

```
{
"code": 200,
"msg": "success",
"[]": [
{
"username": "userc",
"nickname": "User C",
"email": "userc@localhost",
"id": 3
},
{
"username": "userb",
"nickname": "User B",
"email": "userb@localhost",
"id": 2
}
]
}
```

Please run [demo](../../demo/README.md) project and try it.