Skip to content
This repository has been archived by the owner on Feb 5, 2023. It is now read-only.
/ api-doc-php Public archive

This is a simple open source API documentation project

License

Notifications You must be signed in to change notification settings

leihenshang/api-doc-php

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API-DOC

概览

api-doc 是一个轻量化的api接口文档工具。支持markdown编写文档,能够方便前后端对于接口文档和项目文档的查看。后端采用PHP编写,前端使用VUE编写。

鸣谢

图片名称

技术栈

该项目为前后端分离项目, php7.2(Yii2框架) 提供后端接口 ,vue2.0 作为前端开发框架 ,mysql5.7 作为数据库。

目录说明

  • front 前端文件夹
  • backend 后端文件夹

使用方法

前端

  1. 进入front(前端)文件夹,首先执行yarn install安装依赖,接着执行yarn serve

后端

  1. 进入backend文件夹,执行composer install安装依赖,接着执行php yii serve --port=1000
  2. 初始化超级管理员
    • 在backend目录下执行 php yii init/user
    • 超级管理员忘记密码 php yii init/user true

数据库初始化

  • 在mysql中执行 database/mysql.sql 的SQL脚本即可。

仓库地址

项目概览

登录 api概述 api详情 项目文档 api列表