uniondrug/postman

export uniondrug application as documents and postman.json

3.1.4 2021-01-28 06:50 UTC

Requires

• uniondrug/framework: ^2.0

Requires (Dev)

• uniondrug/console: ^2.2

proprietary

• Uniondrug Dev Team

• phalcon
• Postman

README

以命令行的模式, 一健导出Markdown文档、Postman接口工具、SDK。

字段配置

默认	名称	用途
NO	auth	鉴权状态 NO: 关闭 YES: 开启, 通过SDK访问时需要鉴权
--	name	项目名称 导出文档在POSTMAN工具中显示的项目名称 注: 若不指定则使用应用配置项app.appName的值
--	description	项目描述 导出文档在POSTMAN工具中显示的一段项目描述信息
--	sdkLink	出入参文档连接 在导出的SDK类中, 每个方法的PHPDOC片段中, 加入原始项目的连接地址前缀

{
    "name" : "异步消息双向转发", 
    "description" : "基于阿里云MNS的异消息双向转发, 应用端调用", 
    "sdkLink" : "https://uniondrug.coding.net/p/module.mbs2/git/tree/development"
}

如何导出

php console postman

接受指令

1. alias -
2. exec -
3. delete -
4. get -
5. head -
6. ignore -
7. input -
8. mock -
9. options -
10. output -
11. patch -
12. post -
13. put -
14. route -
15. routeprefix -
16. sdk -
17. validator -
18. var -
19. version -

alias

desc

exec

desc

delete

desc

get

desc

head

desc

ignore

desc

input

desc

mock

desc

options

desc

output

desc

patch

desc

post

desc

put

desc

route

desc

routeprefix

desc

sdk

desc

validator

desc

var

desc

version

desc