Api接口文档

Rap2YApi

rap-2-convert-yapi-controller

Rap2接口转YApi：生成Swagger导入json

基本信息

Path： /api/v1/rap2/json/swagger

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
dataUrl	是	http://IP:PORT/repository/get?id=id&token=token	Rap2仓库数据URL

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须		是否成功	mock: @boolean
code	number	非必须		状态码	mock: @integer
message	string	非必须		消息	mock: @string
data	string []	非必须		文件列表	item 类型: string
├─		非必须		文件地址

Rap2接口转YApi：生成Swagger导入json

基本信息

Path： /api/v1/rap2/json/swagger/{repositoryId}/{token}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
repositoryId		Rap2仓库Id
token		接口token

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
code	number	非必须
message	string	非必须
data	string []	非必须			item 类型: string
├─		非必须

Rap2接口转YApi：生成YApi导入json

基本信息

Path： /api/v1/rap2/json/yapi

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
dataUrl	是	http://IP:PORT/repository/get?id=id&token=token	Rap2仓库数据URL

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
code	number	非必须
message	string	非必须
data	string []	非必须			item 类型: string
├─		非必须

Rap2接口转YApi：生成YApi导入json

基本信息

Path： /api/v1/rap2/json/yapi/{repositoryId}/{token}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
repositoryId		Rap2仓库Id
token		接口token

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
code	number	非必须
message	string	非必须
data	string []	非必须			item 类型: string
├─		非必须

rap-convert-yapi-controller

Rap 接口转 YApi 导入 json

<a id=Rap 接口转 YApi 导入 json>

基本信息

Path： /api/v1/rap/json/{type}/{rapProjectId}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
rapProjectId		rap项目Id
type		处理类型：module：模块作为分类，page:页面作为接口分类；默认为module

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
code	number	非必须
message	string	非必须
data	string []	非必须			item 类型: string
├─		非必须

Rap 接口转 YApi 导入 json（一个json)

<a id=Rap 接口转 YApi 导入 json（一个json)>

基本信息

Path： /api/v1/rap/json/toOne/{type}/{rapProjectId}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
rapProjectId		rap项目Id
type		处理类型：module：模块作为分类，page:页面作为接口分类；默认为module

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
code	number	非必须
message	string	非必须
data	string []	非必须			item 类型: string
├─		非必须

​