itkg/api-doc-bundle

API 文档包

维护者

详细信息

github.com/itkg/api-doc-bundle

主页

源代码

问题

安装次数: 8,108

依赖者: 0

建议者: 0

安全性: 0

星标: 0

关注者: 5

分支: 1

开放问题: 0

v1.0.0 2015-03-26 08:37 UTC

Requires

Requires (Dev)

MIT b74217329efa9f5da7438723f65ebbf0aa71d02f

  • Pascal DENIS <pascal.denis.75.woop@gmail.com>

apibundledocinterakting

This package is not auto-updated.

Last update: 2024-09-14 16:08:05 UTC

README

在 NelmioApiDocBundle 的基础上提供更多功能

Build Status Scrutinizer Code Quality Code Coverage SensioLabsInsight

特性

  • 资源注解以提供 markdown 文件列表
  • 新方法面板（资源面板）以显示作为 HTML 的 markdown 资源（使用 Parsedown 库）

安装

通过 Composer 安装

如果你使用 composer，将 ItkgApiDocBundle 包作为依赖项添加到应用的 composer.json 文件中

     "require": {
         "itkg/api-doc-bundle": "dev-master"
     }
  • 将 Itkgapi-docBundle 添加到你的应用内核。
// app/AppKernel.php
<?php
     // ...
     public function registerBundles()
     {
         $bundles = array(
             // ...
             new Itkg\ApiDocBundle\ItkgApiDocBundle(),
         );
     }
  • 通过添加到应用配置文件 config.yml 中激活 bundle 配置
itkg_api_doc: ~

待办事项

  • 将带有资源的文档 API 导出为 PDF