# flight

**Repository Path**: chensdafdsf/flight

## Basic Information

- **Project Name**: flight
- **Description**: 航班项目，开干
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-04-27
- **Last Updated**: 2024-08-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 项目功能介绍以及页面详情
地址：https://mp.weixin.qq.com/s/JlrBAz79XsuUv44iaKgHNw
## 接口文档 

- [航班后台管理系统接口文档 https://localhost:8080/swagger-ui.html](https://localhost:8080/swagger-ui.html)

## 模块介绍

| 模块名        |                                          |      |
| ------------- | ---------------------------------------- | ---- |
| flight-mbg    | 通过Mybaits-x插件自动生成的文件、dto、vo |      |
| flight-common | 异常处理、默认Swagger配置、工具类        |      |
| flight-admin  | 后台管理接口                             |      |

## 接口规范

### 1. 使用swagger动态生成接口文档，必须确保接口文档完整生成

> 必须有完整的入参，完整的返回值描述

熟念 使用 `@Api` `@ApiOperation`  `@ApiModelProperty` `@ApiParam `  等注解

### 2. 方法命名严格遵循驼峰命名法

⚠️⚠️⚠️ 不要在代码中出现错误单词，严重谴责，已经警告了还不修改。有警告，一定要重视。能处理就处理。

### 3. 接口请求方式遵循 restful风格

[参考：怎样用通俗的语言解释REST，以及RESTful？](https://www.zhihu.com/question/28557115)

### 4. 了解一下 什么是 HTTP状态码！！！

项目中常见状态码

- **2xx – 请求成功**
- **4xx – 客户端错误；**
  - **400 - 请求错误（错误信息 展示给用户看）**
  - **401 - 认证失败；**
  - **403 – 禁止访问；**
  - **404 – 接口未找到；**
- **5xx – 服务器错误；**

🧐**重点：**请求返回2xx，按照文档解析数据。请求4xx时，返回固定是以下格式json。前端将 `message` 展示给用户看即可

```json
{
  "code": "请求出错",
  "message": "请求出错"
}
```

### 5. 文档注释

```java
/**
 * 批量删除
 * @param flightList
 * @return
 */
```

这种不写 参数解释的，不写返回值说明的，要删掉。改成下面的情况。

```java
/**
 * 批量删除
 */
```

### 6. 接口的请求对象和返回对象不要使用Map

无法生成接口字段描述。通过创建对象接收或者返回。使用 Mpa 增大了前后端沟通成本。

想起来在补充吧。。。

## 发布

### 打包images

```shell
mvn clean package  -pl flight-admin -am
```

### 启动服务

```shell
docker run --link mysql:mysql --name flight-admin -p 8099:8099 -d bannerxu/flight-admin:0.0.1-SNAPSHOT
docker run --name user-center -p 8002:8002 -d ccr.ccs.tencentyun.com/flight/flight-cloud:user-center
 --link nacos:nacos --link mysql:mysql -name xx -p xx:xx -d 
```

### 关闭服务

```shell
docker rm -f flight-admin
```

### 查看日志

```shell
docker logs -f flight-admin
```

### 前端部署位置

```shell
/data/html/admin/
```