一个使用django生成的简单的API管理工具,可以方便编写API文档,感谢原作者提供的代码,原作者项目所在地址
和原作者相比增加了以下特性
- 支持python3+
- django2.0+
- 可以在windows上开发并预览(使用了pymysql数据库驱动连接)
- 修复了textarea无法随文字高度变化的bug
- 简化参数处理,自定义中间件,自定义异常处理
- 修改了部分模型
- python3 required
- django 2.0+ required
- mysql required
- pymysql required
- uwsgi required
- supervisor required
-
创建虚拟环境
python3 -m venv env
-
安装依赖
env/bin/pip install -r requirements.txt
-
生成配置文件
cd deploy.template sh genconf.sh
-
修改配置文件
本地调试修改dev_settings.py即可 正式上线请修改prod_settings
-
同步数据库
python manage.py makemigrations python manage.py migrate
-
收集静态文件
python manage collectstatic
-
创建用户
python manage.py createsuperuser
-
开始本地测试
python manage runserver
-
将项目上传至服务器
-
生成配置文件
cd deploy.template sh genconf.sh
-
配置uwsgi 修改deploy下的uwsgi配置参数,注意要将server修改为prod,表示为正式环境 相关示例文件可参考deploy/uwsgi.ini 更多uwsgi配置项可以参考官方文档
-
配置nginx 相关实例文件参考deploy目录下nginx_api.conf文件 更多nginx配置项请参阅官方文档
-
使用supervisor管理uwsgi进程 具体可参考deploy/api_manager.conf 如果你对supervisor还不是很了解,你可以先查阅下官方文档 当然,你也可以不使用supervisor,直接在screen裸跑uwsgi也是可以的
-
建立log目录,根据需要touch出相应的日志文件
-
如何重启?
进入项目所在目录执行reload.sh脚本即可~注意,要想此重启方法有效,你必须按照上述部署规范部署项目
再次感谢原作者提供的代码和授权,如果你觉得这个工具不错,不妨也给原作者一个star吧,这里是原作者的github地址
项目遵循LGPL-3.0开源协议,具体详情请参阅相关许可文件的详细信息