njuhel / swagger-to-md

此包已被弃用且不再维护。未建议替代包。

将swagger（多文件或普通文件）转换为基于模板文件的markdown文档文件。生成的文档更像是一个文档骨架，而不是一个完整的文档文件（取决于swagger文件中的文档）

维护者

详细信息

github.com/njuhel/php-swagger-to-md

类型:package

dev-master 2016-09-05 19:46 UTC

Requires

php: >=5.4.0
njuhel/swagger-validator: >=1.1.0
twig/twig: *

Requires (Dev)

codeclimate/php-test-reporter: dev-master
evert/phpdoc-md: >=0.2
phpdocumentor/phpdocumentor: >=2.0
phpunit/php-code-coverage: >=2.1
phpunit/php-file-iterator: >=1.4
phpunit/php-text-template: >=1.2
phpunit/php-timer: >=1.0
phpunit/phpunit: >4.8
phpunit/phpunit-mock-objects: >=2.3

Suggests

None

Provides

None

Conflicts

None

Replaces

None

Apache-2.0 beba99f5bac79b9597af8e739b67ea0f439f2ed9

Nicolas JUHEL <swaggervalidator.woop@nabbar.com>

php api template markdown doc transform OAI md swagger restfull openapi skeletton

dev-master
dev-develop

This package is not auto-updated.

Last update: 2023-08-28 08:28:34 UTC

README

~ ~ ~

PHP Swagger To Markdown (md)

根据模板将swagger（多文件/单文件）转换为md文档

基于PHP Swagger Validator将Swagger（OpenAPI）转换为markdown文件作为辅助工具。拥有基于swagger文件的md文档文件，对解释每个公开资源需要什么很有帮助

Swagger是OpenAPI项目的旧名称，它管理着OAI规范

需要做

发布第一个版本

兼容性

帮助我们修复与兼容性的错误

范围PHP 5.5至PHP 7.0

安装指南

作为子模块安装到git仓库中

git submodule init
git submodule add --branch v1.0.x https://github.com/njuhel/php-swagger-to-md build/lib/swagger-to-md
git submodule update

通过克隆git安装

git clone --branch v1.0.x https://github.com/njuhel/php-swagger-to-md swagger-to-md

通过composer安装（在composer.json中添加此内容）

    "require": {
        "njuhel/swagger-to-md":">=1.0.0"
    },

通过phar安装

wget https://github.com/njuhel/php-swagger-to-md/raw/v1.0.x/bin/Swagger-to-md.phar

示例 & 文档

示例 : Example.php
文档 : 生成的