《《API文档模板》word版.doc》由会员分享,可在线阅读,更多相关《《API文档模板》word版.doc(4页珍藏版)》请在金锄头文库上搜索。
1、项目推荐接口文档1. 目录项目推荐接口文档11. 目录12. 版本信息13. 接口说明14. 获取项目推荐列表16.项目详情37. 实体参数38. ProjectsModel 实体39. CategoryModel410. IndustryModel423.ProjectsModel411. 枚举说明412. 联系方式42. 版本信息版本号时间编写人员说明V1.0.0.02015/4/25刘志明起稿3. 接口说明4. 获取项目推荐列表5. Api地址:环境Api地址测试环境真实环境6. 参数定义:参数名称参数类型可空说明nodecodeStringN会员账号cidIntY所属类别idpages
2、izeIntN每页显示的数据条数(默认为8)pageindexIntN当前页数(默认为1)SignStringN数据签名,签名顺序按此表格参数顺序。函数返回ResultBoolN 处理成功失败MessageStringY如果处理失败则为失败原因,成功则为无。DataListY项目推荐列表集合请参考ProjectsModel 实体5.获取自己的推荐项目列表1. Api地址:环境Api地址测试环境真实环境2. 参数定义:参数名称参数类型可空说明nodecodeStringN会员账号StatusIntY状态(0=未审核 1=审核成功 2=审核失败)pagesizeIntN每页显示的数据条数(默认为8
3、)pageindexIntN当前页数(默认为1)SignStringN数据签名,签名顺序按此表格参数顺序。函数返回ResultBoolN 处理成功失败MessageStringY如果处理失败则为失败原因,成功则为无。DataListY项目推荐列表集合请参考ProjectsModel 实体6.项目详情3. Api地址环境Api地址测试环境真实环境2.参数定义参数名称参数类型可空说明ProjectIdIntN项目idSignStringN数据签名,签名顺序按此表格参数顺序。函数返回ResultBoolN 处理成功失败MessageStringY如果处理失败则为失败原因,成功则为无。DataProjectsModelY项目推荐列表集合请参考7. 实体参数8. ProjectsModel 实体参数名称参数类型是否为空N/Y说明9. CategoryModel参数名称参数类型是否为空说明10. IndustryModel 参数名称参数类型是否为空说明23.ProjectsModel参数名称参数类型是否为空说明11. 枚举说明值说明0说明1说明2说明12. 联系方式姓名工作QQ手机号码工作邮箱 2 / 4