# swagger-yapi

**Repository Path**: heetrance/swagger-yapi

## Basic Information

- **Project Name**: swagger-yapi
- **Description**: swagger-yapi安装文档
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-07-30
- **Last Updated**: 2023-07-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# swagger-yapi

#### 介绍
yapi接口文档，swagger生成json文件导出yapi，展示api

#### 安装教程
本系统为ubuntu
1.  安装npm
    ```
     sudo apt install npm
    ```
2.  安装docker
    ```
    sudo apt install docker.io
    ```
3.  安装mongo
    ```
    sudo docker pull mongo:latest
    ```
4.  运行mongo
    ```
    // 1.运行mongo服务，因为内部api文档不设置用户名密码了
    docker run -d --name yapi-mongo -p 27017:27017 mongo
    ```
5.  进入mongo服务
    ```
    docker exec -it yapi-mongo /bin/bash
    ```
6.  进入mongo交互命令环境
    ```
    mongo //如果使用命令mongo提示未找到，是mongo本版问题，6.0之后用mongosh

    mongosh
    ```
7.  创建名为yapi的DB，这个在可视化部署用得上
    ```
    use yapi
    查看所有DB
    show dbs
    ```
8. 安装yapi
    > 执行 yapi server 启动可视化部署程序，输入相应的配置和点击开始部署，就能完成整个网站的部署。部署完成之后，可按照提示信息，执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定url, 点击登录输入您刚才设置的管理员邮箱，默认密码(ymfe.org) 登录系统（默认密码可在个人中心修改）。
    ```
    npm install -g yapi-cli --registry https://registry.npm.taobao.org
    yapi server
    ```
9.  配置
    - 安装的yapi server后系统将自动运行可视化部署程序(http://localhost:9090)，输入相应的配置并点击开始部署,(选择最低的版本部署)
    - 如果部署的时候使用的是默认端口配置，那网站访问的地址就是：http://localhost:3000 ，初始管理员账号：admin@admin.com，密码：ymfe.org