REST API 项目教程

REST API 项目教程

rest-apiAPI就是开发者使用的界面。我的目标不仅是能用，而且好用, 跨平台(PC, Android, IOS, etc…)使用; 本项目将详细介绍API的设计及异常处理, 并将异常信息进行封装友好地反馈给前端.项目地址:https://gitcode.com/gh_mirrors/rest/rest-api

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

rest-api/
├── app/
│   ├── __init__.py
│   ├── api/
│   │   ├── __init__.py
│   │   ├── endpoints/
│   │   │   ├── __init__.py
│   │   │   ├── user.py
│   │   │   └── product.py
│   │   └── models/
│   │       ├── __init__.py
│   │       ├── user.py
│   │       └── product.py
│   ├── config/
│   │   ├── __init__.py
│   │   ├── development.py
│   │   └── production.py
│   ├── main.py
│   └── utils/
│       ├── __init__.py
│       └── helpers.py
├── tests/
│   ├── __init__.py
│   ├── test_user.py
│   └── test_product.py
├── requirements.txt
├── README.md
└── setup.py

目录结构介绍

• app/: 项目的主要代码目录。
  • api/: 包含API的定义和实现。
    • endpoints/: 包含各个API端点的实现。
    • models/: 包含数据模型的定义。
  • config/: 包含项目的配置文件。
  • main.py: 项目的启动文件。
  • utils/: 包含一些通用的工具函数。
• tests/: 包含项目的测试代码。
• requirements.txt: 列出了项目所需的Python依赖包。
• README.md: 项目的说明文档。
• setup.py: 用于项目的安装和打包。

2. 项目的启动文件介绍

main.py

main.py 是项目的启动文件，负责初始化应用并启动服务器。以下是文件的主要内容：

from flask import Flask
from app.api import api_blueprint
from app.config import development

app = Flask(__name__)
app.config.from_object(development)

app.register_blueprint(api_blueprint, url_prefix='/api')

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

启动文件介绍

• Flask 应用初始化: Flask(__name__) 初始化了一个Flask应用实例。
• 配置加载: app.config.from_object(development) 加载了开发环境的配置。
• 蓝图注册: app.register_blueprint(api_blueprint, url_prefix='/api') 注册了API蓝图，所有API端点都将以 /api 为前缀。
• 启动服务器: app.run(debug=True) 启动了Flask开发服务器，并开启了调试模式。

3. 项目的配置文件介绍

config/ 目录

config/ 目录包含了项目的配置文件，主要用于定义不同环境下的配置参数。

development.py

DEBUG = True
SQLALCHEMY_DATABASE_URI = 'sqlite:///dev.db'
SQLALCHEMY_TRACK_MODIFICATIONS = False

production.py

DEBUG = False
SQLALCHEMY_DATABASE_URI = 'mysql://user:password@localhost/prod'
SQLALCHEMY_TRACK_MODIFICATIONS = False

配置文件介绍

• DEBUG: 控制是否开启调试模式。
• SQLALCHEMY_DATABASE_URI: 定义数据库的连接字符串。
• SQLALCHEMY_TRACK_MODIFICATIONS: 控制是否跟踪对象的修改。

这些配置文件可以根据不同的环境（如开发、测试、生产）进行切换，以适应不同的需求。

rest-apiAPI就是开发者使用的界面。我的目标不仅是能用，而且好用, 跨平台(PC, Android, IOS, etc…)使用; 本项目将详细介绍API的设计及异常处理, 并将异常信息进行封装友好地反馈给前端.项目地址:https://gitcode.com/gh_mirrors/rest/rest-api