YApi 项目使用教程

YApi 项目使用教程

yapiDocker for YApi 一键部署YApi项目地址:https://gitcode.com/gh_mirrors/yap/yapi

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

YApi 项目的目录结构如下：

yapi/
├── config
│   └── config.json
├── docs
│   └── README.md
├── src
│   ├── controllers
│   ├── models
│   ├── routes
│   └── services
├── public
│   └── index.html
├── package.json
└── server.js

目录结构介绍

• config/: 存放项目的配置文件，如 config.json。
• docs/: 存放项目的文档文件，如 README.md。
• src/: 项目的源代码目录，包含控制器、模型、路由和服务等。
• public/: 存放静态文件，如 index.html。
• package.json: 项目的依赖管理文件。
• server.js: 项目的启动文件。

2. 项目的启动文件介绍

项目的启动文件是 server.js，其主要功能是启动服务器并加载必要的模块和配置。

const express = require('express');
const app = express();
const config = require('./config/config.json');

app.use(express.static('public'));

app.get('/', (req, res) => {
  res.sendFile(__dirname + '/public/index.html');
});

app.listen(config.port, () => {
  console.log(`Server is running on port ${config.port}`);
});

启动文件介绍

• 引入 express 模块并创建一个应用实例。
• 加载配置文件 config.json。
• 设置静态文件目录为 public。
• 定义根路由的处理函数，返回 index.html 文件。
• 启动服务器并监听配置文件中指定的端口。

3. 项目的配置文件介绍

项目的配置文件是 config/config.json，其主要包含服务器的端口和其他相关配置。

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "user": "root",
    "password": "123456",
    "database": "yapi"
  }
}

配置文件介绍

• port: 服务器监听的端口号。
• database: 数据库连接配置，包括主机、用户名、密码和数据库名。

以上是 YApi 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用 YApi 项目。

yapiDocker for YApi 一键部署YApi项目地址:https://gitcode.com/gh_mirrors/yap/yapi