Archery Restful API #1475

nick2wang · 2022-04-20T05:57:24Z

fix #354

目前支持的接口：

用户/用户组/资源组CRUD
实例CRUD/实例资源
SQL上线工单清单/SQL检查/提交SQL上线工单/待审核清单/审核工单/执行工单/工单日志

Restful API框架： django-rest-framework
JWT验证：djangorestframework-simplejwt
OpenAPI swagger：drf-spectacular

OpenAPI swagger-ui：
http://archeryhost:9123/api/swagger/

redoc：
http://archeryhost:9123/api/redoc/

使用：

设置token lifetime
access_token lifetime: settings.SIMPLE_JWT['ACCESS_TOKEN_LIFETIME']
refresh_token lifetime: settings.SIMPLE_JWT['REFRESH_TOKEN_LIFETIME']
配置API_USER_WHITELIST，将API账号添加至白名单
使用API账号获取token

curl \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"username": "archery_api_user", "password": "archery_api_user_password"}' \
  http://archeryhost:9123/api/token/

Responses:
{
    "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTY1MjU5ODA3OCwiaWF0IjoxNjUwMDA2MDc4LCJqdGkiOiIwMjM3MjA5ZTBiY2U0ZThmYjI1MTI3ZTU3NDU3NDZjMSIsInVzZXJfaWQiOjI1fQ.iQZP1-lvtgV84KmwI-eq5WyhMI4Yj9jLiVO1QpyFXWc",
    "access": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjUyNTk4MDc4LCJpYXQiOjE2NTAwMDYwNzgsImp0aSI6IjYwMTBjYzNlMmI4NjQxNjA4MWFmMzEyNzdhYjQ0M2RmIiwidXNlcl9pZCI6MjV9.el6V4MbJmJZF_rclDwrOEbi1rpMcCVAmRAPfmPeflwU"
}

使用access_token请求业务接口

curl \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjUyNTk4MDc4LCJpYXQiOjE2NTAwMDYwNzgsImp0aSI6IjYwMTBjYzNlMmI4NjQxNjA4MWFmMzEyNzdhYjQ0M2RmIiwidXNlcl9pZCI6MjV9.el6V4MbJmJZF_rclDwrOEbi1rpMcCVAmRAPfmPeflwU" \
  http://archeryhost:9123/api/xxx/

使用refresh_token刷新token

curl \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"refresh":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTY1MjU5ODA3OCwiaWF0IjoxNjUwMDA2MDc4LCJqdGkiOiIwMjM3MjA5ZTBiY2U0ZThmYjI1MTI3ZTU3NDU3NDZjMSIsInVzZXJfaWQiOjI1fQ.iQZP1-lvtgV84KmwI-eq5WyhMI4Yj9jLiVO1QpyFXWc"}' \
  http://archeryhost:9123/api/token/refresh/

codecov · 2022-04-20T06:21:14Z

Codecov Report

Merging #1475 (3e6690c) into master (ce05f31) will increase coverage by 0.53%.
The diff coverage is 81.91%.

@@            Coverage Diff             @@
##           master    #1475      +/-   ##
==========================================
+ Coverage   74.89%   75.43%   +0.53%     
==========================================
  Files          83       91       +8     
  Lines       13432    14431     +999     
==========================================
+ Hits        10060    10886     +826     
- Misses       3372     3545     +173

Impacted Files	Coverage Δ
sql/models.py	`96.48% <ø> (+0.83%)`	⬆️
sql/urls.py	`100.00% <ø> (ø)`
sql/user.py	`58.33% <58.33%> (ø)`
sql_api/api_workflow.py	`65.51% <65.51%> (ø)`
sql_api/api_instance.py	`69.49% <69.49%> (ø)`
sql_api/serializers.py	`81.46% <81.46%> (ø)`
sql_api/api_user.py	`90.32% <90.32%> (ø)`
common/middleware/check_login_middleware.py	`100.00% <100.00%> (ø)`
sql_api/filters.py	`100.00% <100.00%> (ø)`
sql_api/pagination.py	`100.00% <100.00%> (ø)`
... and 6 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ce05f31...3e6690c. Read the comment docs.

LeoQuote · 2022-04-20T08:00:12Z

太强了, 这是在里面实现了一个 oauth 吗?

nick2wang · 2022-04-20T10:19:38Z

太强了, 这是在里面实现了一个 oauth 吗?

oauth要实现有点繁重，所以用了现成的simplejwt，不用建表

LeoQuote · 2022-04-21T01:25:14Z

有没有办法直接开放所有人生成API key ？你觉得会有这个需求吗

nick2wang · 2022-04-21T01:39:22Z

有没有办法直接开放所有人生成API key ？你觉得会有这个需求吗

权限类IsInUserWhitelist目前是我自定义的限定白名单用户，这里如果配置成内置的rest_framework.permissions.IsAuthenticated就可以实现所有人用户授权（内置的还有AllowAny、IsAdminUser等），如果要定制权限只要稍加修改sql_api/permissions.py
https://github.com/nick2wang/Archery/blob/c7214afc8f10e833a37c9961e39fecace7b86f58/archery/settings.py#L186

nick2wang · 2022-04-21T01:50:49Z

默认所有用户都可以获取token，不过只有授权的用户可以请求业务接口，当前配置是全局使用一个权限类，也可以对每个接口应用不同的权限类

LeoQuote

LGTM

LeoQuote · 2022-04-22T04:30:18Z

如果archery 自己的前端想用 api 应该怎么做改造?

nick2wang · 2022-04-22T10:26:41Z

如果archery 自己的前端想用 api 应该怎么做改造?

用户登录archery前端时让后端生成一个token返回存储在前端，前端每次调用业务接口时把token添加到header里？或者api同时启用jwt和session认证？

nick2wang · 2022-04-24T03:45:49Z

使用session鉴权post api时同样需要csrftoken，这样archery前端使用api时就不需要做额外处理，也不需要关注token的lifetime问题，内部调用api使用session，外部调用使用jwt

LeoQuote

LGTM

方便对接其他程序，内部的系统也可以慢慢迁到api

hhyo · 2022-04-24T14:12:32Z

已合并，可以更新下wiki文档

nick2wang · 2022-04-25T02:40:58Z

已合并，可以更新下wiki文档

wiki已更新

dc-vin · 2022-08-24T04:26:00Z

API字段没有详细描述，比如errlevel有几个等级，需要我去一个一个尝试，希望文档能得到补充

dc-vin · 2022-08-24T10:41:08Z

fix #354

目前支持的接口：

用户/用户组/资源组CRUD

实例CRUD/实例资源

SQL上线工单清单/SQL检查/提交SQL上线工单/待审核清单/审核工单/执行工单/工单日志

Restful API框架： django-rest-framework JWT验证：djangorestframework-simplejwt OpenAPI swagger：drf-spectacular

OpenAPI swagger-ui： http://archeryhost:9123/api/swagger/

redoc： http://archeryhost:9123/api/redoc/

使用：

设置token lifetime
access_token lifetime: settings.SIMPLE_JWT['ACCESS_TOKEN_LIFETIME']
refresh_token lifetime: settings.SIMPLE_JWT['REFRESH_TOKEN_LIFETIME']

配置API_USER_WHITELIST，将API账号添加至白名单

使用API账号获取token
curl \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"username": "archery_api_user", "password": "archery_api_user_password"}' \
  http://archeryhost:9123/api/token/

Responses:
{
    "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTY1MjU5ODA3OCwiaWF0IjoxNjUwMDA2MDc4LCJqdGkiOiIwMjM3MjA5ZTBiY2U0ZThmYjI1MTI3ZTU3NDU3NDZjMSIsInVzZXJfaWQiOjI1fQ.iQZP1-lvtgV84KmwI-eq5WyhMI4Yj9jLiVO1QpyFXWc",
    "access": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjUyNTk4MDc4LCJpYXQiOjE2NTAwMDYwNzgsImp0aSI6IjYwMTBjYzNlMmI4NjQxNjA4MWFmMzEyNzdhYjQ0M2RmIiwidXNlcl9pZCI6MjV9.el6V4MbJmJZF_rclDwrOEbi1rpMcCVAmRAPfmPeflwU"
}
使用access_token请求业务接口
curl \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjUyNTk4MDc4LCJpYXQiOjE2NTAwMDYwNzgsImp0aSI6IjYwMTBjYzNlMmI4NjQxNjA4MWFmMzEyNzdhYjQ0M2RmIiwidXNlcl9pZCI6MjV9.el6V4MbJmJZF_rclDwrOEbi1rpMcCVAmRAPfmPeflwU" \
  http://archeryhost:9123/api/xxx/
使用refresh_token刷新token
curl \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"refresh":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTY1MjU5ODA3OCwiaWF0IjoxNjUwMDA2MDc4LCJqdGkiOiIwMjM3MjA5ZTBiY2U0ZThmYjI1MTI3ZTU3NDU3NDZjMSIsInVzZXJfaWQiOjI1fQ.iQZP1-lvtgV84KmwI-eq5WyhMI4Yj9jLiVO1QpyFXWc"}' \
  http://archeryhost:9123/api/token/refresh/

/api/auth/token/verify/ 这个接口校验token是否有效，如果token有效返回的是一个空对象，我觉得返回一个状态码更好。基于API做处理也会更简单

LeoQuote · 2022-08-24T10:57:04Z

你好, 欢迎你提出新的 issue , 本pr 已经 merge, 讨论已经结束了, 另外你所说的改进项欢迎 pr

iszhangsc · 2024-03-29T06:21:25Z

我需要调用API接口，请问一下这两个步骤在哪里这只我没有找到。
1.设置token lifetime
access_token lifetime: settings.SIMPLE_JWT['ACCESS_TOKEN_LIFETIME']
refresh_token lifetime: settings.SIMPLE_JWT['REFRESH_TOKEN_LIFETIME']
2.配置API_USER_WHITELIST，将API账号添加至白名单

nick2wang added 7 commits April 20, 2022 13:33

Restful API

3ecbb9c

新增配置项API_USER_WHITELIST

758c3be

新增OpenAPI swagger菜单

518675f

单元测试

0b6b4a8

更新依赖

4c6a714

更新依赖2

b3c791f

更新依赖3

c7214af

This comment was marked as outdated.

# to view

LeoQuote previously approved these changes Apr 22, 2022

View reviewed changes

增加session鉴权方式

3e6690c

nick2wang dismissed LeoQuote’s stale review via 3e6690c April 24, 2022 03:42

LeoQuote approved these changes Apr 24, 2022

View reviewed changes

hhyo merged commit a952075 into hhyo:master Apr 24, 2022

Repository owner locked as resolved and limited conversation to collaborators Mar 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Archery Restful API #1475

Archery Restful API #1475

nick2wang commented Apr 20, 2022 •

edited

Loading

codecov bot commented Apr 20, 2022 •

edited

Loading

This comment was marked as outdated.

LeoQuote commented Apr 20, 2022

nick2wang commented Apr 20, 2022

LeoQuote commented Apr 21, 2022

nick2wang commented Apr 21, 2022 •

edited

Loading

nick2wang commented Apr 21, 2022

LeoQuote left a comment

LeoQuote commented Apr 22, 2022

nick2wang commented Apr 22, 2022 •

edited

Loading

nick2wang commented Apr 24, 2022

LeoQuote left a comment

hhyo commented Apr 24, 2022

nick2wang commented Apr 25, 2022

dc-vin commented Aug 24, 2022

dc-vin commented Aug 24, 2022

LeoQuote commented Aug 24, 2022

iszhangsc commented Mar 29, 2024

Archery Restful API #1475

Archery Restful API #1475

Conversation

nick2wang commented Apr 20, 2022 • edited Loading

codecov bot commented Apr 20, 2022 • edited Loading

Codecov Report

This comment was marked as outdated.

LeoQuote commented Apr 20, 2022

nick2wang commented Apr 20, 2022

LeoQuote commented Apr 21, 2022

nick2wang commented Apr 21, 2022 • edited Loading

nick2wang commented Apr 21, 2022

LeoQuote left a comment

Choose a reason for hiding this comment

LeoQuote commented Apr 22, 2022

nick2wang commented Apr 22, 2022 • edited Loading

nick2wang commented Apr 24, 2022

LeoQuote left a comment

Choose a reason for hiding this comment

hhyo commented Apr 24, 2022

nick2wang commented Apr 25, 2022

dc-vin commented Aug 24, 2022

dc-vin commented Aug 24, 2022

LeoQuote commented Aug 24, 2022

iszhangsc commented Mar 29, 2024

nick2wang commented Apr 20, 2022 •

edited

Loading

codecov bot commented Apr 20, 2022 •

edited

Loading

nick2wang commented Apr 21, 2022 •

edited

Loading

nick2wang commented Apr 22, 2022 •

edited

Loading