YApi

dev-env-resource

# 一、YApi简介

YApi文档 (opens new window)

体验地址 (opens new window)

YApi,API管理私服,强大的开源API接口可视化管理平台。

旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API。

# 二、YApi安装

# Windows安装

windows安装YApi (opens new window)

# Docker安装

docker-compose.yml

version: '3'

services:
  yapi-web:
    image: liuqingzheng/yapi:latest
    container_name: yapi-web
    ports:
      - 8084:3000
    environment:
      - YAPI_ADMIN_ACCOUNT=admin@company.com
      - YAPI_ADMIN_PASSWORD=ADMIN123456
      - YAPI_CLOSE_REGISTER=true
      - YAPI_DB_SERVERNAME=yapi-mongo
      - YAPI_DB_PORT=27017
      - YAPI_DB_DATABASE=yapi
      - YAPI_MAIL_ENABLE=false
      - YAPI_LDAP_LOGIN_ENABLE=false
      - YAPI_PLUGINS=[]
    depends_on:
      - yapi-mongo
    links:
      - yapi-mongo
    restart: always
  yapi-mongo:
    image: mongo:5
    container_name: yapi-mongo
    volumes:
      - ./data/db:/data/db
    expose:
      - 27017
    restart: always

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

# 三、YApi使用

YApi管理界面:http://localhost:8084 (opens new window),YApi使用邮箱进行登录。

第一步:使用admin账号(YAPI_ADMIN_ACCOUNT)登录系统;

第二步:用户——创建用户;

第三步:项目——创建分组、创建项目;

第四步:接口——创建分类、创建接口;