PHP download

Download the PHP package weiwei2012holy/eolinker-doc without Composer

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

Table of contents
Download weiwei2012holy/eolinker-doc
More information about weiwei2012holy/eolinker-doc
Files in weiwei2012holy/eolinker-doc

Vendor weiwei2012holy
Package eolinker-doc
Short Description eolinker api doc generate tool
License MIT

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 weiwei2012holy/eolinker-doc

Informations about the package eolinker-doc

eolinker-doc

eolinker api doc generate tool.

Installing

使用说明

使用eolikner作为api接口文档管理
后台使用apidoc类型注释,通过命令可以一键生成文档
各种字段的描述,定义一次即可多次复用
用了这个工具包,效率至少提高30%,减少了大量重复的写文档工作,不用每修改接口都要去翻一遍接口源文档进行修改,自从用了这个工具以后,前后端的关系明显变得更加和谐了^_^

一段简单的接口注释

实际生成效果

参数说明

注意事项:

1.默认解析路由中,action位于App\Http\Controllers下的接口

2.接口需要配置name,基本规则:应用.模块.功能,具体可以根据实际情况灵活调配,该类型的命名,对应了eolikner后台的分组关系

3.参数目前只会修改和增加,不会删除原本的数据

4.注释写法,参考apidoc规范

5.~~路由uri包含api/admin前缀,统一会再名称上面增加后台标记~~

支持的apidoc标签

@api {method} path [title] ,默认会使用 php artisan route:list里面name,path,method
@apiName name,接口名称,有该值将会覆盖路由命名里面的值
@apiDescription text api接口详细描述或者写一些其他说明
@apiParam [(group)] [{type}] [field=defaultValue] [description] ,请求参数定义,有效值:类型,字段名,描述,是否可选,默认值
@apiSuccess [(group)] [{type}] [field=defaultValue] [description] 返回值定义
@apiParam和@apiSuccess中的defaultValue ,如果格式为:defaultValue={FuleNameOfModel@field1,field2},将会获取model对应mysql数据库字段描述信息最为返回值,FuleNameOfModel为model完整的名称,包含完整的命名空间,@后接字段名称,可以过来过滤字段返回(可选)
1. 在模型中 use EolinkerDoc\Traits\ModelInfo,可以重写其中的getTableFullColumnsCustom方法实现覆盖源字段和增加数据库不存在字段
2. todo 分表模型需要处理
3. 注释示例:
@apiStatus 标记接口状态: 接口正常提供服务:[working,on],接口维护中:[maintain,todo],接口已废弃:[deprecated,down],默认接口状态为正常

License

MIT

All versions of eolinker-doc with dependencies

PHP Build Version

Package Version

Version 1.2.11 Release 28. May 2021
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of eolinker-doc from vendor weiwei2012holy

Requires php Version >=7.0
illuminate/container Version *
illuminate/database Version *

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 weiwei2012holy/eolinker-doc contains the following files

Loading the files please wait ....