PHPackages                             xianrenqh/apidoc2-webman - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. xianrenqh/apidoc2-webman

ActiveLibrary[API Development](/categories/api)

xianrenqh/apidoc2-webman
========================

Webman plugin xianrenqh/apidoc2-webman

v0.0.3(4y ago)191MITPHPPHP >=7.1.0

Since Jun 30Pushed 4y ago1 watchersCompare

[ Source](https://github.com/xianrenqh/apidoc2-webman)[ Packagist](https://packagist.org/packages/xianrenqh/apidoc2-webman)[ RSS](/packages/xianrenqh-apidoc2-webman/feed)WikiDiscussions master Synced 3w ago

READMEChangelog (1)Dependencies (2)Versions (4)Used By (0)

api-doc-Webman
==============

[](#api-doc-webman)

webman 版本的 api-doc

扒拉的 **ThinkPHP ApiDoc** ，改成了webman版本的，部分功能可能无法使用（去掉了缓存、多语言）。

ThinkPHP ApiDoc官网：

安装
--

[](#安装)

> composer require xianrenqh/apidoc2-webman

访问：
---

[](#访问)

文档默认地址为：

可以在config里面进行更改路由：

**路由配置文件地址：**

\\config\\plugin\\xianrenqh\\apidoc2-webman\\route.php

**apidoc基本配置文件：**

config/plugin/xianrenqh/apidoc2-webman/apidoc.php

Nginx反向代理问题
-----------

[](#nginx反向代理问题)

解决nginx反向代理后页面上的js/css文件无法加载的方法：

问题现象：

nginx配置反向代理后，网页可以正常访问，但是页面上的js、css和图片等资源都无法访问。

- （1）nginx配置如下：
- （2）域名访问：js css文件无法加载；
- （3）IP访问：js css文件可以正常加载；
- （4）CI框架下无法访问

解决方法：

nginx配置文件中，修改为如下配置：

（宝塔的话：找到站点，设置，配置文件里修改）

```
location ~ \.php$ {
                proxy_pass http://127.0.0.1:8787;
                include naproxy.conf;
        }
        location ~ .*\.(gif|jpg|jpeg|png|bmp|swf)$ {
                expires      30d;
                proxy_pass http://127.0.0.1:8787;
                include naproxy.conf;
        }

        location ~ .*\.(js|css)?$ {
                expires      12h;
                proxy_pass http://127.0.0.1:8787;
                include naproxy.conf;
        }

```

需要把静态文件也添加反向代理设置。

简单使用案例：
-------

[](#简单使用案例)

官网教程地址：

### 1、编辑apidoc.php文件：

[](#1编辑apidocphp文件)

找到config/plugin/xianrenqh/apidoc2-webman/apidoc.php文件并编辑：

编辑 apps键（大概第13行-20行）

增加你需要的api的controllers控制器 例如：

```
'controllers' => [
    'app\api\controller\UserController',
],

```

### 2、在控制器中添加注解

[](#2在控制器中添加注解)

打开控制器： app\\api\\controller\\UserController

#### 引入解释文件

[](#引入解释文件)

注意：在官网中引用的是：

**use hg\\apidoc\\annotation as Apidoc;**

我们不要引入上面的， 要引入下面的：

```
use xianrenqh\Apidoc2Webman\annotation as Apidoc;

```

换句话说， 官网只要是 **use hg\\apidoc\\annotation**， 我们都要替换为：

> use xianrenqh\\Apidoc2Webman\\annotation

#### 控制器注释

[](#控制器注释)

为控制器加上一些注释，以让文档可读性更高（当然这不是必须的）

```