Metadata-Version: 2.1
Name: golive-django-openapi
Version: 0.5.7
Summary: 青橄榄Django OpenAPI框架
Home-page: https://jh-golive-gitlab.goliveplus.cn/golive-project-manage/golive-django-openapi
Author: fk
Author-email: fkfkbill@gmail.com
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: pydantic<2
Requires-Dist: fastapi<2
Requires-Dist: django
Requires-Dist: django-comment-migrate==0.1.5
Requires-Dist: loguru
Requires-Dist: apscheduler
Requires-Dist: schema

青橄榄Django OpenAPI框架
=======================


## 框架简述

在django的基础上，保留django的便利ORM，以开发RESTful风格的接口为目标，构建一个支持输出openapi文档的框架。

最早本框架只用于OA的开发，因为数据平台相关开发类似，为避免重复维护框架代码，故而把框架代码抽象出来单独成库。

## 功能点

* 输出RESTful风格的openapi接口文档。支持Django原生的Model，兼容大部分常用字段类型。
* 接口输入输出的类型校验+转换，使接口与文档定义一致。
* 内置redoc，可直接配置文档展示。
* 接口URL路由根据目录结构自动索引，规避冗长的url.py配置文件。
* 多项核心附加工具：可输出的状态机，支持结构定义的JSONField等等。

## 核心依赖

* Django
* Pydantic
