|
|
@@ -22,8 +22,10 @@
|
|
|
参见[github](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md)
|
|
|
|
|
|
## raml2swagger处理
|
|
|
-raml1.0暂时没有tags的服务，因此通过路径来维护接口的分组，参见`raml2swagger.js`
|
|
|
-
|
|
|
+- raml1.0暂时没有tags的服务，因此通过路径来维护接口的分组，参见`raml2swagger.js`
|
|
|
+- 通过displayName指定接口名字
|
|
|
+- 一些traits如response，在面对数组时用引号括起来如 `is: [response: { typeName: 'User[]' }]`
|
|
|
+- 对于一些traits如pagable，在同时包含queryParameters和responses时会有bug，导致typeName无法正确处理，这里可以考虑将pagable的traits分成两个分别处理queryParameters和responses
|
|
|
|
|
|
## 如何为其他api文档仓库接入ci？
|
|
|
- 该仓库定义了一些比较好的split 来帮助开发者维护raml文件，同时用了一些常用的traits机制方便重用某些结构，你可以参照该仓库的结构定义自己的raml结构。
|
wanghongkai