REST API 基础教程

REST API 基础教程

REST-API-BasicsThis is a basic guide on how to build a REST API with Django & Python. For much deeper depth, check out our new course on REST API: (https://kirr.co/90kxtx)项目地址:https://gitcode.com/gh_mirrors/re/REST-API-Basics

1. 项目的目录结构及介绍

REST-API-Basics/
├── README.md
├── app
│   ├── __init__.py
│   ├── config.py
│   ├── models.py
│   ├── routes.py
│   └── utils.py
├── requirements.txt
├── run.py
└── tests
    ├── __init__.py
    └── test_api.py

• README.md: 项目说明文件。
• app: 应用主目录，包含所有应用相关的代码。
  • __init__.py: 初始化应用实例。
  • config.py: 配置文件，包含应用的配置信息。
  • models.py: 数据库模型定义。
  • routes.py: API路由定义。
  • utils.py: 工具函数和辅助类。
• requirements.txt: 项目依赖文件。
• run.py: 项目启动文件。
• tests: 测试目录，包含所有测试相关的代码。
  • __init__.py: 初始化测试模块。
  • test_api.py: API测试用例。

2. 项目的启动文件介绍

run.py

from app import create_app

app = create_app()

if __name__ == "__main__":
    app.run(debug=True)

• create_app(): 从 app 模块导入的函数，用于创建应用实例。
• app.run(debug=True): 启动应用，开启调试模式。

3. 项目的配置文件介绍

config.py

import os

class Config:
    SECRET_KEY = os.environ.get('SECRET_KEY') or 'your_secret_key'
    SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL') or 'sqlite:///site.db'
    SQLALCHEMY_TRACK_MODIFICATIONS = False

• SECRET_KEY: 应用密钥，用于加密。
• SQLALCHEMY_DATABASE_URI: 数据库连接URI。
• SQLALCHEMY_TRACK_MODIFICATIONS: 是否跟踪对象的修改，设置为 False 以减少内存使用。

以上是基于开源项目 REST-API-Basics 的教程内容，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助！

REST-API-BasicsThis is a basic guide on how to build a REST API with Django & Python. For much deeper depth, check out our new course on REST API: (https://kirr.co/90kxtx)项目地址:https://gitcode.com/gh_mirrors/re/REST-API-Basics