# api-doc-php

**Repository Path**: leihenshang/api-doc-php

## Basic Information

- **Project Name**: api-doc-php
- **Description**: 使用golang编写的api接口文档应用，支持md文档编写和用户权限管理。
- **Primary Language**: PHP
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://gitee.com/leihenshang/api-doc-php
- **GVP Project**: No

## Statistics

- **Stars**: 7
- **Forks**: 0
- **Created**: 2019-09-29
- **Last Updated**: 2023-04-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: apidoc, Markdown, 接口文档, Go语言

## README

# API-DOC

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

## 鸣谢

 <img src="jetbrains.png" width = "200" height = "218.6" alt="图片名称" align=center />

- 感谢 `JetBrains` 提供的IDE支持！
- 相关: [JetBrains网站](https://www.jetbrains.com/?from=apiDoc)

### 技术栈
该项目为前后端分离项目, php7.2(Yii2框架) 提供后端接口 ,vue2.0 作为前端开发框架 ,mysql5.7 作为数据库。
  
### 目录说明
- front 前端文件夹
- backend 后端文件夹

### 使用方法
#### 前端
1. 进入front（前端)文件夹,首先执行yarn install安装依赖,接着执行yarn serve
#### 后端
2. 进入backend文件夹,执行composer install安装依赖,接着执行php yii serve --port=1000
3. 初始化超级管理员
   - 在backend目录下执行  php yii init/user
   - 超级管理员忘记密码 php yii init/user true


### 数据库初始化
- 在mysql中执行 database/mysql.sql 的SQL脚本即可。

## 仓库地址
- `github:`https://github.com/leihenshang/apiDoc
- `gitee:`https://gitee.com/leihenshang/apiDoc

## 项目概览
![登录](https://images.gitee.com/uploads/images/2020/0531/222925_7c0239aa_1719135.png "start.png")
![api概述](https://images.gitee.com/uploads/images/2020/0531/222953_cf831496_1719135.png "detail.png")
![api详情](https://images.gitee.com/uploads/images/2020/0531/223008_68e4cfa8_1719135.png "api-detail.png")
![项目文档](https://images.gitee.com/uploads/images/2020/0531/223021_69ae4f2e_1719135.png "doc.png")
![api列表](https://images.gitee.com/uploads/images/2020/0531/223047_4d5916ce_1719135.png "api-list.png")