自动文档生成生成的案例。
是这篇文章的结果演示，下面的内容是直接调取对应的接口实时生成，未经过人工编辑。
https://www.jianshu.com/p/bc54478b9609
实际仓库地址，可以自己测试下。 https://github.com/xiaobai1993/fast-think
项目列表（测试注释标题）
业务功能
用于再后台展示项目列表，显示列表，测试注释
这一行也要拿出来
接口地址
/xxx/xxx.project/lists
请求参数
| 参数名称 | 是否必填 | 参数类型 | 案例 | 说明 |
|---|---|---|---|---|
| search_publish_status | Y | String | 例如:PUBLISHED
|
状态 |
| search_name | N | String | 例如:保留
|
项目名称 |
返回数据
{
"code": 0,
"msg": "success",
"data": {
"total": 72531,
"per_page": 1,
"current_page": 1,
"last_page": 72531,
"data": [
{
"guid": 1508625,
"name": "保留",
"date_of_publication": 0,
"company_guid": 1508624,
"publish_status": "PUBLISHED",
"status": "OPEN",
"logo": "2019\/1022\/f7dfff1467dba845fbe66be0f5bb81a4.jpg",
"total_score": 0,
"entity_data": {
"guid": 1508625,
"subtype": "PROJECT",
"father_guid": 0,
"created_by": 529317,
"created_at": 1573195299,
"updated_at": 1574233902,
"updated_by": 1,
"is_visible": 1,
"weight": 0,
"pv": 0,
"old_id": 0,
"old_model": 0,
"created_data": {
"user_id": xxxx,
"realname": "xxx.xxx"
},
"updated_data": {
"user_id": 1,
"realname": "超级xxx员"
}
},
"company_data": {
"guid": 1508624,
"head_office_country_id": 7066,
"current_funding_stage": 0,
"head_office_province_id": 25,
"head_office_city_id": 405,
"registration_country_id": 7066,
"registration_province_id": 25,
"registration_city_id": 405,
"full_name": "华佗在线科技有限责任公司",
"logo": "2019\/1022\/f7dfff1467dba845fbe66be0f5bb81a4.jpg",
"registration_province_data": {
"id": 25,
"name": "云南"
},
"registration_city_data": {
"id": 405,
"name": "昆明"
},
"registration_country_data": {
"id": 7066,
"name": "中国"
},
"head_office_country_data": {
"id": 7066,
"name": "中国"
},
"head_office_city_data": {
"id": 405,
"name": "昆明"
},
"head_office_province_data": {
"id": 25,
"name": "云南"
},
"current_funding_stage_data": null
},
"sector_data": [],
"logo_full_path": "https:\/\/oss.xxx.cn\/2019\/1022\/f7dfff1467dba845fbe66be0f5bb81a4.jpg",
}
]
}
}
| 参数名称 | 参数类型 | 说明 |
|---|---|---|
| code | Number | 编码 |
| msg | String | 提示信息 |
| data | Object | 数据 |
| data.total | Number | 总数 |
| data.per_page | Number | 每页大小 |
| data.current_page | Number | 当前页 |
| data.last_page | Number | 最后页码 |
| data.data | Array | 数据 |
| data.data.guid | Number | 项目的id |
| data.data.name | String | 项目名称 |
| data.data.date_of_publication | Number | 成立时间 |
| data.data.company_guid | Number | 公司关联ID |
| data.data.publish_status | String | 状态 |
| data.data.status | String | 状态 |
| data.data.logo | String | logo |
| data.data.total_score | Number | 项目的完整度分数 |
| data.data.entity_data | Object | 实体信息 |
| data.data.entity_data.guid | Number | guid |
| data.data.entity_data.subtype | String | 类型 |
| data.data.entity_data.father_guid | Number | 父Id |
| data.data.entity_data.created_by | Number | 添加人 |
| data.data.entity_data.created_at | Number | 添加时间 |
| data.data.entity_data.updated_at | Number | 编辑人 |
| data.data.entity_data.updated_by | Number | 编辑时间 |
| data.data.entity_data.is_visible | Number | 是否显示 |
| data.data.entity_data.weight | Number | 排序 |
| data.data.entity_data.pv | Number | pv |
| data.data.entity_data.old_id | Number | 旧id |
| data.data.entity_data.created_data | Object | 创建人 |
| data.data.entity_data.created_data.user_id | Number | user_id |
| data.data.entity_data.created_data.realname | String | 真实姓名 |
| data.data.entity_data.updated_data | Object | 更新人信息 |
| data.data.entity_data.updated_data.user_id | Number | user_id |
| data.data.entity_data.updated_data.realname | String | 真实姓名 |
| data.data.company_data | Object | 项目所属的公司信息 |
| data.data.company_data.guid | Number | guid |
| data.data.company_data.head_office_country_id | Number | 国家 |
| data.data.company_data.current_funding_stage | Number | 当前融资轮次 |
| data.data.company_data.head_office_province_id | Number | 省 |
| data.data.company_data.head_office_city_id | Number | 市 |
| data.data.company_data.registration_country_id | Number | 国家 |
| data.data.company_data.registration_province_id | Number | 省 |
| data.data.company_data.registration_city_id | Number | 市 |
| data.data.company_data.full_name | String | 全称 |
| data.data.company_data.logo | String | logo |
| data.data.company_data.registration_province_data | Object | 公司注册地所在的省份 |
| data.data.company_data.registration_province_data.id | Number | id |
| data.data.company_data.registration_province_data.name | String | 名称 |
| data.data.company_data.registration_city_data | Object | 公司注册地所在的城市 |
| data.data.company_data.registration_city_data.id | Number | id |
| data.data.company_data.registration_city_data.name | String | 名称 |
| data.data.company_data.registration_country_data | Object | 公司注册地所在的国家 |
| data.data.company_data.registration_country_data.id | Number | id |
| data.data.company_data.registration_country_data.name | String | 名称 |
| data.data.company_data.head_office_country_data | Object | 公司所在的国家 |
| data.data.company_data.head_office_country_data.id | Number | id |
| data.data.company_data.head_office_country_data.name | String | 名称 |
| data.data.company_data.head_office_city_data | Object | 公司所在的城市 |
| data.data.company_data.head_office_city_data.id | Number | id |
| data.data.company_data.head_office_city_data.name | String | 名称 |
| data.data.company_data.head_office_province_data | Object | 公司所在的省份 |
| data.data.company_data.head_office_province_data.id | Number | id |
| data.data.company_data.head_office_province_data.name | String | 名称 |
| data.data.company_data.current_funding_stage_data | Object | 公司当前融资阶段数据 |
| data.data.sector_data | Array | 行业领域 |
| data.data.logo_full_path | String | 获取图片的名字 |
网友评论