frobou/frobou-doc-go 问题修复 & 功能扩展

解决BUG、新增功能、兼容多环境部署,快速响应你的开发需求

邮箱:yvsm@zunyunkeji.com | QQ:316430983 | 微信:yvsm316

frobou/frobou-doc-go

Composer 安装命令:

composer require frobou/frobou-doc-go

包简介

Frobou auto generate documentation

README 文档

README

SensioLabsInsight

--- readme mal e porcamente escrito, nao é o foco agora...

regras:

classe deve ter anotacao @endpoint e @name

/**

  • @entrypoint
  • @name DocTestClassApi
    */
    @entrypoint indica se a classe é um ponto de entrada
    @name indica o nome do recurso

cada classe apta deve ter anotacoes nos metodos necessarios, exemplo:

/**
 * @endpoint
 * @name umnomeaqui
 * @description Manda a carroça para algum lugar
 * @method GET
 * @expected {"arg1": "","arg2":"","arg3":""}
 * @field $arg1=decricao do campo
 * @field $arg2=descricao do campo
 * @optfield $arg3=descricao do campo
 * @rule $arg1=deve ser uma string
 * @rule $arg2=deve ser um inteito de 0 a 10
 * @optrule nome=true para pinda, false para monhangaba
 * @obs Para que o recurso funcione é necessário que use o PHP
 * @example {"arg1": "Carroça","arg2":5,"arg3":true}
 * @return {"A carroça foi 5 vezes para pinda"}
 */
public function func1($arg1, $arg2, $arg3=false)
{
	return $arg1 + $arg2;
}

para usar faça o seguinte:
crie o objeto principal
$api = new FrobouDocApi();
vasculhe uma classe anotada
$obj = $api->getClassDoc(DocTestClassApi::class);
use o array associativo resultante da forma que precisar.

uma ideia é criar uma anotação @teste teste=(valor1=valor,valor2=valor) e parsear conforme necessário
a imaginação é o limite

统计信息

  • 总下载量: 70
  • 月度下载量: 0
  • 日度下载量: 0
  • 收藏数: 0
  • 点击次数: 0
  • 依赖项目数: 0
  • 推荐数: 0

GitHub 信息

  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • 开发语言: PHP

其他信息

  • 授权协议: MIT
  • 更新时间: 2016-12-09

承接程序开发

PHP开发

VUE

Vue开发

前端开发

小程序开发

公众号开发

系统定制

数据库设计

云部署

网站建设

安全加固