PHP download

Download the PHP package shaoyikai/api-doc without Composer

On this page you can find all versions of the php package shaoyikai/api-doc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download shaoyikai/api-doc
More information about shaoyikai/api-doc
Files in shaoyikai/api-doc

Vendor shaoyikai
Package api-doc
Short Description An excellent api document generator
License BSD-3-Clause
Homepage https://github.com/shaoyikai/api-doc

Keywords project template api doc

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of shaoyikai/api-doc

Informations about the package api-doc

API 文档生成器

随着现代应用越来越复杂，前后分离也变得越来越流行。

为什么呢？

因为分离之后，前后端可以更加专注地去做各自更擅长的事情。前端：专心地去编写UI设计的漂亮界面和交互，功能上只需要调用后台开发好的一个个API即可；后端：专注于应用的处理逻辑编写，数据库的设计等，最终把输入和输出封装成一个个清晰的API供前端人员调用。前后端需求有变更的时候，各自不会互相影响，非常有利于后期的维护。

可是，前后端配合得愉快吗？……

前后分离很好，可是为什么很多开发人员，还是被沟通搞得焦头烂额了呢？我觉得主要是因为没有一个清晰的接口文档，更准确的说，是没有一个“及时更新的”“清晰的”接口文档！

so，本程序旨在方便快捷的编写api文档，同时提供一些有用的工具，让编写api文档成为一件轻松惬意的工作！

先睹为快

目录结构

项目采用PHP框架yii2 framework，目录结构如下：

  assets/
  commands/
  config/
  controllers/
  mail/
  models/
  runtime/
  tests/
  vendor/
  views/
  web/

安装说明

该程序运行所需要的PHP版本为 5.5以上，因为5.4以下的composer会报错。
如果尚未安装composer插件composer-asset-plugin，您需要执行composer global require "fxp/composer-asset-plugin:~1.1.1"进行安装
执行安装命令：composer create-project shaoyikai/api-doc
创建数据库api-doc，字符集选择utf-8，配置数据库config/db.php
在根目录执行命令：php yii migrate ，选择yes。（需将php添加到系统环境变量）
配置虚拟主机（如：http://demo.api-doc.com）到 /web/ 目录下面。

配置数据库参考

编辑文件 config/db.php：

Apache虚拟主机配置参考

注意： 数据库需要手动创建

待开发功能

功能列表

License

api-doc is released under the BSD License. See the bundled LICENSE for details.

All versions of api-doc with dependencies

PHP Build Version

Package Version

Version v1.0.2 Release 25. Aug 2017
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of api-doc from vendor shaoyikai

Requires php Version >=5.4.0
yiisoft/yii2 Version >=2.0.5
yiisoft/yii2-bootstrap Version *
yiisoft/yii2-swiftmailer Version *
phpdocumentor/phpdocumentor Version 2.*
cliff363825/yii2-kindeditor Version v1.0.5
phpoffice/phpword Version v0.10.*

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package shaoyikai/api-doc contains the following files

Loading the files please wait ....