# 歪fChat后台管理系统后端

**Repository Path**: wifi-skew-f/waif-cms-backend

## Basic Information

- **Project Name**: 歪fChat后台管理系统后端
- **Description**: 歪fChat后台管理系统，采用NestJS + TypeScript + MongoDB
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 3
- **Created**: 2024-07-13
- **Last Updated**: 2025-05-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 歪fChat后台管理系统后端

## 项目描述
歪fChat后台管理系统，采用NestJS + TypeScript + MongoDB

## 生成 java 代码

使用 `OpenAPI Generator` 生成 `Spring Boot` 接口框架。

1. 首先需要安装 OpenAPI Generator CLI：

```bash
npm install @openapitools/openapi-generator-cli -g
```

2. 准备 OpenAPI 规范文件。你可以从现有的 Swagger 文档导出，或者手动创建一个 yaml 文件，例如 api-docs.yaml ：

```yaml
openapi: 3.0.0
info:
  title: Waif CMS API
  description: Waif CMS 后端 API 文档
  version: 1.0.0
servers:
  - url: http://localhost:3000/api/cms
paths:
  /user:
    get:
      summary: 获取用户列表
      responses:
        '200':
          description: 成功返回用户列表
```

3. 使用 OpenAPI Generator 生成 Spring Boot 代码：

```bash
openapi-generator-cli generate -i api-docs.yaml -g spring -o spring-server --api-package com.example.api --model-package com.example.model --library spring-boot
```

主要参数说明：

- `-i` : 输入的 OpenAPI 规范文件
- `-g` : 生成器名称，这里使用 spring
- `-o` : 输出目录
- `--api-package` : API 接口包名
- `--model-package` : 模型类包名

4. 生成的项目结构将包含：
- Controller 接口类
- Model 数据模型类
- API 接口文档
- pom.xml 配置文件

5. 其他常用配置选项：

```bash
# 生成带有验证注解的代码
openapi-generator-cli generate -i api-docs.yaml -g spring -o spring-server --library spring-boot --use-beanvalidation

# 生成带有示例的代码
openapi-generator-cli generate -i api-docs.yaml -g spring -o spring-server --generate-alias-as-model
```