Yapi是一个比较好用的api文档工具，项目地址 https://github.com/YMFE/yapi
# 一站式解决方案
项目地址 https://github.com/fjc0k/docker-YApi
## docker-compose部署
```
version: '3'

services:
  yapi-web:
    image: jayfong/yapi:latest
    container_name: yapi-web
    ports:
      # 映射到本地端口40001，也可修改为其他端口
      - 40001:3000
    environment:
      - YAPI_ADMIN_ACCOUNT=admin@docker.yapi
      - YAPI_ADMIN_PASSWORD=admin
      - YAPI_CLOSE_REGISTER=true
      - YAPI_DB_SERVERNAME=yapi-mongo
      - YAPI_DB_PORT=27017
      - YAPI_DB_DATABASE=yapi
      - YAPI_DB_USER=admin
      - YAPI_DB_PASS=123456
      - YAPI_DB_AUTH_SOURCE=admin
      - YAPI_MAIL_ENABLE=false
      - YAPI_LDAP_LOGIN_ENABLE=false
      - YAPI_PLUGINS=[]
    depends_on:
      - yapi-mongo
    links:
      - yapi-mongo
    restart: unless-stopped
  yapi-mongo:
    # centos7等低版本系统需要降低mongo的版本，可设置为mongo:4.2
    image: mongo:latest
    container_name: yapi-mongo
    volumes:
      - ./data/db:/data/db
    # 把端口暴露给此内部容器网络（同一个Docker网络），但是不暴露给主机网络
    expose:
      - 27017
    environment:
      - MONGO_INITDB_ROOT_USERNAME=admin
      - MONGO_INITDB_ROOT_PASSWORD=123456
    restart: unless-stopped
```

:::note{title="注"}
未指定网络的情况下，docker-compose会自动创建一个网络。这个网络的生命周期由docker compose管理，并在docker-compose up执行时创建，在docker-compose down执行时删除。
:::
# 组装式解决方案
## 构建镜像
```
FROM node:12-alpine as builder
WORKDIR /yapi
RUN apk add --no-cache wget python make
ENV VERSION=1.9.2
RUN wget -O yapi-${VERSION}.zip https://github.com/YMFE/yapi/archive/v${VERSION}.zip
RUN unzip yapi-${VERSION}.zip && mv yapi-${VERSION} vendors
RUN cd /yapi/vendors && cp config_example.json ../config.json && npm install --production --registry https://registry.npm.taobao.org

FROM node:12-alpine
ENV TZ="Asia/Shanghai"
WORKDIR /yapi/vendors
COPY --from=builder /yapi/vendors /yapi/vendors
EXPOSE 3000
ENTRYPOINT ["node"]
```
## 启动容器
```
docker run -d \
  --link mongo-yapi:mongo \
  --workdir /yapi \
  -p 3000:3000 \
  -v $PWD/config.json:/config.json \
  yapi:latest \
  server/app.js
```
这个太麻烦了


Yapi

以下是一个例子：
```
# ---------------------下面定义了几个变量---------------------------
# 
# swagger文档生成目录
SWAGGER_GEN_DIR := docs
# swagger文档最终存放目录
TARGET_SWAGGER_DIR := ./pkg/common/swagger/docs
# swagger文档生成命令
SWAGGER_INIT := swag init -g cmd/main.go
# ---------------------------------------------------------------



# ---------------------下面声明了几个目标是伪目标--------------------
#.PHONY是一个特殊标志，指示后面的目标名不依赖于实际存在的文件，而是伪目标。伪目标通常用来执行特定的操作，而不是生成文件。
.PHONY: swagger clean prepare 
# ---------------------------------------------------------------



# ---------------------下面定义了几个目标---------------------------
# swagger为目标，prepare为目标所需的依赖（可以是伪目标或者实际存在的文件），第一个目标为默认目标，可以直接用make命令执行，也可以使用make swagger执行
swagger: prepare
# 命令，需要以Tab字符开头，而不能是空格符。@符号的作用是抑制命令的回显，否则make执行一个命令时，会首先回显到命令到终端，然后再执行。如果不想在命令执行前被打印出来，就在前面加上@符号
    @echo "Generating Swagger Documentation..."
# 变量替换，执行变量存储的命令，如果不想展示命令，可以使用 @$(SWAGGER_INIT)
    $(SWAGGER_INIT)
# 变量替换
    @echo "Moving Swagger Documentation to $(TARGET_SWAGGER_DIR)"
    cp -r $(SWAGGER_GEN_DIR)/* $(TARGET_SWAGGER_DIR)/
    rm -rf $(SWAGGER_GEN_DIR)
    @echo "Swagger documentation moved and updated successfully!"
    
# 定义目标prepare
prepare:
    @echo "Preparing target directory..."
    mkdir -p $(TARGET_SWAGGER_DIR)
    
# 定义目标clean
clean:
    @echo "Cleaning generated Swagger files..."
    rm -rf $(TARGET_SWAGGER_DIR)
    @echo "Clean complete."
# ---------------------------------------------------------------
```

Makefile

收货地址表
```
id          int    //自增id
phone       string    //手机号，收货人手机，不一定是用户本人
addr        string    //收货地址
houseNumber string    //收获门牌号
userid      string    //用户id，此账号所属人id
typ         int       //类型，家，公司，学校  貌似不太需要这个
```
首页配置表
```
bannerImage string  //banner图片地址
footerImage string  //footer图片地址
```
用户表
```
id           int    //自增id，用户id，对应收货地址表的userid
phone        string    //手机号
score        string    //积分
money        int64     //储值，充值100，送20，所以储值有优惠，单位分
qrcode       string    //或者生成码，用户唯一二维码，将由此码生成，且带有时间属性
createTime   time.Time //用户注册时间
externalId   string    //外部id，比如微信id
externalPlat string    //外部平台，比如微信、支付宝、抖音
```
优惠劵表
```
id            int    //自增id
money         int64     //含有金额
minimumCharge int64     //最低消费多少金额，才能使用
typ           string    //优惠劵类型，新人，奖励，老用户，过节
name          string    //优惠劵名称 比如新人礼
endTime       time.Time //最后截止日期
startTime     time.Time //开始可以使用日期
createTime    time.Time //创建日志
userid        string    //用户id，此账号所属人id
qrcode       string    //或者生成码，优惠券唯一二维码，将由此码生成，且带有时间属性
```
订单表
```
id         int        //自增id
createTime time.Time  //创建时间
userid     string     //用户id
addrid     int        //地址id
money      int64      //金额
```

-----------------------------终结-------------------------------
我觉得这个事.....能成的概率太低了，因此不再继续投入时间

外卖点单小程序设计

## vscode配置中文
### 一、下载扩展包
可以直接在vscode的扩展应用里面下载`Chinese (Simplified) (简体中文) Language Pack for Visual Studio Code`。
### 二、启用中文扩展包
按下`command`+`shift`+`p`,在出现的输入框里面输入`>display language`，选择下面出现的`Configure Display Language`进行点击，然后选择下面出现的`中文（简体）`就可以了。
## vscode remote-ssh远程免密
vscode remote-ssh远程免密，其实核心就是要实现ssh免密登录。即当你在本地实现使用`ssh root@IP`命令免密登录远程机的时候，自然也就是实现了vscode远程开发免密。
### 一、安装配置SSH环境
VS Code Remote - SSH插件是基于OpenSSH的，因此在本机和服务器上都需要安装OpenSSH客户端。在Windows系统中，可以使用Git自带的SSH客户端程序，如果没有安装Git，则需要先安装它。安装完成后，需要将Git的bin目录配置到环境变量的PATH变量下，以便VS Code能够找到SSH客户端程序。

在Linux系统中，可以使用apt-get或yum等命令来安装OpenSSH客户端。安装完成后，可以通过在终端中输入ssh命令来测试SSH环境是否配置成功。

### 二、安装远程开发插件
要在VS Code中使用远程开发功能，需要先安装远程开发插件。打开VS Code的扩展界面，搜索Remote开头的插件，可以看到VS Code提供了多个远程开发插件，包括Remote - SSH、Remote - WSL、Remote - Containers等。我们选择安装Remote - SSH插件。

### 三、配置远程连接
在远程资源管理器视图中，点击“设置按钮”，进入远程机器配置界面。在配置界面中，我们需要输入远程主机的IP地址、用户名和密码等信息，以便VS Code能够连接到远程主机。

连接成功后，我们可以在VS Code中打开远程主机上的项目文件夹，进行远程开发。此时，VS Code会将远程主机上的文件同步到本地，我们可以在本地进行代码编辑、调试等操作，同时也可以实时查看远程主机上的运行结果。

### 四、配置免密连接
1. 复制本地公钥`C:\Users\liudada\.ssh\id_rsa.pub`里面的内容，添加到远程主机的`~/.ssh/authorized_keys`文件里面（如果文件不存在则自己创建，注意权限是否为可读）
```
chmod 700 ~/.ssh
chmod 600 ~/.ssh/authorized_keys
```
2. 检查远程服务器的 SSH 配置文件 /etc/ssh/sshd_config 中，确保`PubkeyAuthentication`选项未被注释且设置为 yes
```
PubkeyAuthentication yes
AuthorizedKeysFile .ssh/authorized_keys
```
修改完成后，需要重启 SSH 服务`sudo systemctl restart sshd
`

3. 本地配置`C:\Users\liudada\.ssh\config`文件，如下
```
Host 172.168.22.23                            //别名
  HostName 172.168.22.23                      //远程主机地址
  User root                                   //远程用户
  IdentityFile C:\Users\liudada\.ssh\id_rsa   //本地私钥位置
```

:::note{title="注"}
ssh -v root@172.168.22.23，可以查看具体的连接日志。
:::

vscode

vscode目前是我比较常用的代码编辑器。特别是remote-ssh功能可以用于远程开发。但是当远程服务器无法访问`update.code.visualstudio.com`时，便无法自动下载`vscode-server`。所以就需要我们自己下载。
### 一、获取vscode的版本信息
版本用 commit_id 来区别，当自动下载`vscode-server`失败时，输出日志会出现下面的内容，那一长串数字就是 commit id
```
...
[14:01:53.970] Using commit id "8b617bd08fd9e3fc94d14adb8d358b56e3f72314" and quality "stable" for server
...

Parsed server configuration: {"serverConfiguration":{"remoteListeningOn":{"socketPath":"127.0.0.1:43571"},"osReleaseId":"ubuntu","arch":"x86_64","sshAuthSock":"","display":"","tmpDir":"/run/user/1000","platform":"linux"},"serverStartTime":43,"installUnpackCode":""}
```
这个`commit id`也就是本地vscode版本的`commit id`

除此之外，也可以在vscode的菜单上通过 Help->About 来查看`commit id`
### 二、下载vscode-server安装包
不同操作系统的vscode-server的下载链接类似下面这样，选择合适的下载链接，替换`commit:`后面的`commit id`，然后就可以进行下载了
```
https://update.code.visualstudio.com/commit:b58957e67ee1e712cebf466b995adf4c5307b2bd/server-linux-x64/stable
https://update.code.visualstudio.com/commit:b58957e67ee1e712cebf466b995adf4c5307b2bd/server-darwin-x64/stable
https://update.code.visualstudio.com/commit:b58957e67ee1e712cebf466b995adf4c5307b2bd/server-darwin-arm64/stable
https://update.code.visualstudio.com/commit:b58957e67ee1e712cebf466b995adf4c5307b2bd/server-linux-alpine/stable
https://update.code.visualstudio.com/commit:b58957e67ee1e712cebf466b995adf4c5307b2bd/server-win32-x64/stable
```
### 三、上传安装包到远程机器
将下载的安装包上传到远程机器，目录如下，${commit_id}就是上一个步骤获取的值
```
~/.vscode-server/bin/${commit_id}
```
解压安装包，**并且将安装包里面所有内容复制到上面内容的目录下**（注意是里面的内容，而不是整个目录）最后删除安装包，操作如下
```
tar -zxvf vscode-server-linux-x64.tar.gz
mv ./vscode-server-linux-x64/* ./
rm -rf vscode-server-linux-x64.tar.gz
```
完成后，在主机上重新打开vscode，就可以连接上了