Skip to content

Commit ff5492e

Browse files
sbzhusbzhu
authored
add readme
1 parent ff57761 commit ff5492e

1 file changed

Lines changed: 37 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,38 @@
1-
# weworkapi_python
2-
official lib of wework api https://work.weixin.qq.com/api/doc
31

4-
python 版企业微信API的使用demo
2+
# About
3+
weworkapi_python 是为了简化开发者对企业微信API接口的使用而设计的，API调用库系列之python版本    
4+
本库仅做示范用，并不保证完全无bug；另外，作者会不定期更新本库，但不保证与官方API接口文档同步，因此一切以[官方文档](https://work.weixin.qq.com/api/doc)为准。
5+
6+
# Director
7+
8+
├── api // API 接口
9+
│   ├── examples // API接口的测试用例
10+
│   ├── README.md
11+
│   └── src // API接口的关键逻辑
12+
├── conf.py
13+
├── README.md
14+
15+
# Usage
16+
将本项目下载到你的目录，既可直接引用相关文件  
17+
详细使用方法参考examples路径下的测试用例
18+
19+
# 关于token的缓存
20+
token是需要缓存的，不能每次调用都去获取token（否者会中频率限制）
21+
在本库的设计里，token是以类里的一个变量缓存的
22+
比如api/src/CorpApi.py 里的access_token变量
23+
在类的生命周期里，这个accessToken都是存在的， 当且仅当发现token过期，CorpAPI类会自动刷新token
24+
刷新机制在 api/src/AbstractApi.py
25+
所以，使用时，只需要全局实例化一个CorpAPI类，不要析构它，就可一直用它调函数，不用关心 token
26+
```
27+
api = CorpAPI(corpid, corpsecret);
28+
api.dosomething()
29+
api.dosomething()
30+
api.dosomething()
31+
....
32+
```
33+
当然，如果要更严格的做的话，建议自行修改，全局缓存token，比如存redis、存文件等，失效周期设置为2小时。
34+
35+
# Contact us
36+
abelzhu@tencent.com
37+
38+
#

0 commit comments

Comments
 (0)