swagger php修改成中文,辞职了有些空余时间,做了一个自动 PHP 自动生成 swagger 文档工具,零代码入侵。...

看一些自动生成 swagger 文档的工具,都是要在注释写一些特定的语法,本人有洁癖很难接受写一大坨奇怪语法的东西在注释里边,干脆就撸了一个自动生成 swagger 文档的工具,基于 php-parser语法树构建文档结构。

文档详情:

写得有些糙,目前 manjusaka 只针对courser 自动生成文档。manjusaka 会把大的 swagger 文档拆成若干个小的部分, 手动写过 swagger 文档的人应该知道一旦 api 接口过百,如果是单一个 yaml 文件大几千行,看一下就头疼更别说让人改。

小弟不才如果做得不对,欢迎大神斧正或者贡献代码。

因为是零入侵,所以不可能做的完美,有些地方还需要自己手动改,但已经节省了很大工作(准确的说需要定义 200 response 数据结构和 tag,security )。

入口文件:

---

swagger: '2.0'

################################################################################

# API Information #

################################################################################

info:

version: v0.1.1

title: knight API

description: |

这是 knight 自动生成 API,仅限供参考。api 采用 rest 风格,正常情况下 response statusCode

20x 为成功的返回,

40x 为客户端错误,

50x 为服务端错误,

20x 返回 格式为 { message: 'OK', data: ... }

非 20x 返回 { message: '错误描述', code: '详细请看 api 错误码'}

################################################################################

# Host, Base Path, Schemes and Content Types #

################################################################################

host: localhost

basePath: /

schemes:

- http

produces:

- application/json

consumes:

- application/json

- multipart/form-data

tags:

- name: Auth

description: 认证

- name: Users

description: 用户

paths:

$ref: ./routers/index.yaml

definitions:

$ref: ./definitions/index.yaml

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值