All Projects → itxq → api-doc-php

itxq / api-doc-php

Licence: Apache-2.0 license
根据接口注释自动生成接口文档

Programming Languages

HTML
75241 projects
PHP
23972 projects - #3 most used programming language

Labels

Projects that are alternatives of or similar to api-doc-php

Adoc
📄🖊轻松的的 API MD文档编写工具
Stars: ✭ 92 (+475%)
Mutual labels:  doc
Md
Generate a Markdown Documentation for a SFC Vue Component. Contribute: https://gitlab.com/vuedoc/md#contribute
Stars: ✭ 131 (+718.75%)
Mutual labels:  doc
Creator Docs
Manual docs content for Cocos Creator
Stars: ✭ 201 (+1156.25%)
Mutual labels:  doc
Goreadme
Generate readme file from Go doc. Now available with Github actions!
Stars: ✭ 113 (+606.25%)
Mutual labels:  doc
Wizard
Wizard是一款开源的文档管理工具,支持Markdown/Swagger/Table类型的文档。
Stars: ✭ 1,733 (+10731.25%)
Mutual labels:  doc
Phpstamp
The XSL-way templating library for MS Office Word DOCX documents.
Stars: ✭ 150 (+837.5%)
Mutual labels:  doc
Jsprintmanager
Advanced Client-side Printing & Scanning Solution for Javascript
Stars: ✭ 74 (+362.5%)
Mutual labels:  doc
ilovepdf
Telegram Bot that helps you to convert Images to pdf, pdf to images, 45+ file formats to pdf, more features Soon..
Stars: ✭ 140 (+775%)
Mutual labels:  doc
Arm Neon Intrinsics
arm neon 相关文档和指令意义
Stars: ✭ 128 (+700%)
Mutual labels:  doc
Weui Simple Guide
WeUI 1.0 简明入门指南
Stars: ✭ 183 (+1043.75%)
Mutual labels:  doc
Elm Doc Preview
Elm offline documentation previewer
Stars: ✭ 113 (+606.25%)
Mutual labels:  doc
Eladmin Doc
EL-ADMIN 文档源码
Stars: ✭ 121 (+656.25%)
Mutual labels:  doc
Vue Styleguidist
Created from react styleguidist for Vue Components with a living style guide
Stars: ✭ 2,133 (+13231.25%)
Mutual labels:  doc
Officeproducer
Produce doc/docx/pdf format from doc/docx template
Stars: ✭ 95 (+493.75%)
Mutual labels:  doc
Yarg
Yet Another Report Generator - CUBA Platform reporting engine
Stars: ✭ 215 (+1243.75%)
Mutual labels:  doc
Js Word
✒️ Word Processing Document Library
Stars: ✭ 1,203 (+7418.75%)
Mutual labels:  doc
Django Intro Zh
Django 官方文档的 intro 部分的中文翻译
Stars: ✭ 141 (+781.25%)
Mutual labels:  doc
teedoc
wiki and multi docs friendly static document site generator(doc generator), convert markdown and jupyter notebook to html website. wiki 和多文档友好的静态文档网站生成工具
Stars: ✭ 72 (+350%)
Mutual labels:  doc
Mysql markdown
It can generate markdown structure documents of MySQL succinctly~
Stars: ✭ 227 (+1318.75%)
Mutual labels:  doc
Documentserver
ONLYOFFICE Document Server is an online office suite comprising viewers and editors for texts, spreadsheets and presentations, fully compatible with Office Open XML formats: .docx, .xlsx, .pptx and enabling collaborative editing in real time.
Stars: ✭ 2,335 (+14493.75%)
Mutual labels:  doc

Api-Doc-PHP

主要功能:

  • 根据接口注释自动生成接口文档

演示地址

【Gitee Pages:】http://itxq.gitee.io/api-doc-php

开源地址:

【GigHub:】https://github.com/itxq/api-doc-php

【码云:】https://gitee.com/itxq/api-doc-php

扩展安装:

  • 方法一:composer命令 composer require itxq/api-doc-php

  • 方法二:直接下载压缩包,然后进入项目中执行 composer命令 composer update 来生成自动加载文件

引用扩展:

  • 当你的项目不支持composer自动加载时,可以使用以下方式来引用该扩展包
// 引入扩展(具体路径请根据你的目录结构自行修改)
require_once __DIR__ . '/vendor/autoload.php';

使用扩展:

// 引入扩展(具体路径请根据你的目录结构自行修改)
require_once __DIR__ . '/../vendor/autoload.php';
// 加载测试API类1
require_once __DIR__ . '/Api.php';
// 加载测试API类2
require_once __DIR__ . '/Api2.php'; 
$config = [
    'class'         => ['Api', 'Api2'], // 要生成文档的类
    'filter_method' => ['__construct'], // 要过滤的方法名称
];
$api = new \itxq\apidoc\BootstrapApiDoc($config);
$doc = $api->getHtml();
exit($doc);

具体效果可运行test目录下的index.php查看

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].