# API_qimo **Repository Path**: edithx/api_qimo ## Basic Information - **Project Name**: API_qimo - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2021-01-15 - **Last Updated**: 2021-01-25 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README |文档名称|秘密花园 — 产品需求文档| |:--:|:--| |产品名称|秘密花园(Screct Garden） |产品描述|一款可进行**狗狗识别**，**猫咪识别**，**植物识别**的多功能动植物分析App| |产品版本|1.0| |文件作者|张星| --- ### 一、MVP加/价值主张宣言 #### 1.项目标题 秘密花园 - 大自然，小天地 #### 2.项目简介 本产品主要利用[apishop](https://www.apishop.net/#/)中的智能API，通过简洁易操作的APP界面与功能，为需要查询动植物的信息的用户提供服务。 ### 二、问题需求 #### （一）、使用情境 1.问题情景 - 大学生因为作业需求想要查询动植物的各种信息 - 想要添置一只小宠物，但不知道该如何选择？ - 对大自然的神奇之处感到好奇的人 2.解决方案 - 以用户为中心，利用apishop中的智能API功能，结合简洁易操作的APP界面，解决用户需求。 #### （二）、用户画像 ![用户画像](https://gitee.com/edithx/api_qimo/raw/master/img/%E7%94%A8%E6%88%B7%E7%94%BB%E5%83%8F.jpg) #### （三）、需求列表 | 优先级 | 需求 | 智能加值 | API类型 | |---|---|---|---| | 1 | 狗狗搜索 | 是 | 狗狗关键词搜索 | | 2 | 猫咪搜索 | 是 | 猫咪关键词搜索 | | 3 | 植物搜索 | 是 | 植物关键词搜索 | #### （四）、需求论证 | 人工智能类型 | 狗狗关键词搜索API、猫咪关键词搜索API、植物关键词API | |----------|------------------------------| | 系统性偏差 | 系统性偏差中等，因利用的是没有官方文档的民间智能API | | ESG考量 | 关于用户提供的爱好收藏信息是否会泄露 | ### 三、界面流程及关键智能交互 ### 1. 原型及界面设计 - 交互原型：[体验链接](https://modao.cc/app/design/pbkk773v8v6aly70) 请将“设备类型”调为iPhone X以获得最佳体验。 ![交互及页面设计](https://gitee.com/edithx/api_qimo/raw/master/img/%E4%BA%A4%E4%BA%92%E7%85%A7%E7%89%87.jpg) [想要查看更多请点击这里](https://gitee.com/edithx/api_qimo/tree/master/img) ### 2. 用户旅程 ![用户旅程](https://gitee.com/edithx/api_qimo/raw/master/img/%E7%94%A8%E6%88%B7%E6%97%85%E9%80%94.jpg) ### 3.产品交互图 ![产品交互图](https://gitee.com/edithx/api_qimo/raw/master/img/%E7%94%A8%E6%88%B7%E6%B5%81%E7%A8%8B%E5%9B%BE.jpg) ### 4.价值主张画布 ![价值主张画布](https://gitee.com/edithx/api_qimo/raw/master/img/%E4%BB%B7%E5%80%BC%E4%B8%BB%E5%BC%A0.jpg) ### 四、设计可行性分析 1.用户体验/旅程分析 - 用户注册登录后可自由选择想使用的功能，输入相应关键词后可快速获取信息，得到反馈后继续查询自己想要获得的信息 2.用户可欲性 - 直接通过手机验证码的注册登录方式，省去繁琐的程序，缩短响应时间 - 两个API功能按钮始终悬浮于界面顶部，保证APP内部无死胡同页 - 功能分类，解释清晰，用户可快速获取信息 - 数据流程在后台运行，用户在前端可快速获得响应内容，可欲性强 3.技术可行性 - 通过用户发送的关键词，后台进行筛选查询反馈给用户，用户随即获得信息，安全方便快捷 - 通过前端可视化，只需要填充用户的关键词便可快速调用API 4.商业可行性 - 如今智能手机普及，人们借助手机查询动植物的需求不断增加，此类简单易操作的APP很有增长前景 - 数据操作流程便捷，节约成本 5.加值输入细节 - 通过前端界面，用户只需在清晰的指定位置输入关键词，便可获取信息 6.加值输出细节 - 如详细信息查询页，已做优化，将寿命，性格特征，喂养要点等信息排版后呈现给用户，直观且美观 - 用户获取信息后可将其收藏，用户可在我的足迹以及我的收藏内查看 - 即调即用，信息具有及时性 ### 五、数据流程及关键智能API使用 #### （一）、数据流程图 ![输入图片说明](https://gitee.com/edithx/api_qimo/raw/master/img/%E6%95%B0%E6%8D%AE%E6%B5%81%E7%A8%8B%E5%9B%BE.jpg) #### （二）、[关键API](https://www.apishop.net/#/)调用展示 ##### 1.狗狗关键词搜索 输入 ``` import requests key ="5AGZczH538c065ca18b2353370bb64384a85237067281d1" def dogfind(apikey,keyword): url = 'https://api.apishop.net/common/dogFamily/queryDogListByKeyword' params = {"apiKey":key, "keyword":keyword } r = requests.get(url, params=params) results = r.json()['result']['petFamilyList'] return results keyword='松狮' dogfind(key,keyword) ``` 输出 ``` [{'petID': 133, 'name': '松狮犬', 'engName': 'Chow Chow', 'price': '', 'coverURL': 'http://img.boqiicdn.com/Data/BK/P/img46961406164098.jpg'}] ``` ##### 2.猫猫关键词搜索 输入 ``` import requests key ="5AGZczH538c065ca18b2353370bb64384a85237067281d1" def catfind(apikey,keyword): url = 'https://api.apishop.net/common/catFamily/queryCatListByKeyword' params = {"apiKey":key, "keyword":keyword } r = requests.get(url, params=params) results = r.json()['result']['petFamilyList'] return results keyword='无毛' catfind(key,keyword) ``` 输出 ``` [{'petID': 8, 'name': '加拿大无毛猫', 'engName': 'Sphynx', 'price': '', 'coverURL': 'http://img.boqiicdn.com/Data/BK/P/img66841406110188.jpg'}] ``` ##### 3.植物关键词搜索 输入 ``` import requests key ="5AGZczH538c065ca18b2353370bb64384a85237067281d1" def find(apikey,keyword): url = 'https://api.apishop.net/common/plantFamily/queryPlantListByKeyword' params = {"apiKey":key, "keyword":keyword } r = requests.get(url, params=params) results = r.json()['result']['plantList'] return results keyword='昙花' find(key,keyword) ``` 输出 ``` [{'area': '原产墨西哥，现各地广泛栽培', 'coverURL': 'http://img.boqiicdn.com/Data/BK/P/imagick76261443431323.jpg', 'engName': 'Rhipsalidopsis gaertneri', 'name': '假昙花', 'plantID': 305}, {'area': '', 'coverURL': 'http://img.boqiicdn.com/Data/BK/P/imagick41971441187207.jpg', 'engName': 'Epiphyllum', 'name': '昙花', 'plantID': 494}] ``` ##### 4.狗狗详细信息搜索 输入 ``` import requests key ="5AGZczH538c065ca18b2353370bb64384a85237067281d1" def dogmessage(apikey,petID): url = 'https://api.apishop.net/common/dogFamily/queryDogInfo' params = {"apiKey":key, "petID":petID } r = requests.get(url, params=params) results = r.json()['result'] return results petID='133' dogmessage(key,petID) ``` 输出 ``` {'petID': 133, 'name': '松狮犬', 'engName': 'Chow Chow', 'character': '文静，高雅', 'nation': '中国', 'easyOfDisease': '螨、丝虫病、细小病毒性肠炎、角膜炎、蚤、湿疹、犬脓皮病、过敏性皮炎', 'life': '11-12年', 'price': '', 'des': '一般人看到松狮那张全都堆在一起的囧脸就会觉得它是个憨厚老实，很容易亲近的', 'feature': '松狮犬的腿虽然比较短，但是却肌肉发达，骨骼粗壮，骨量足，厚长的毛让它十分适合在寒冷地区。松狮体格健壮，身体呈方形，短而紧凑，尾根较高，尾巴贴着背部卷起，四肢笔直，强壮有力。被毛厚重，分短毛和粗毛两种，蓝舌头是松狮特有的标志。', 'characterFeature': '松狮喜欢安静，不喜走动，性格也比较高雅，一般不会搞破坏。它的性格更接近于', 'careKnowledge': '松狮有着强健的体格，高雅孤傲的性格，可是养松狮都有一个问题就是它的口水，倒不是因为它的口水量大，而是因为它的“围脖”太厚，口水流出来没地方流，只能全部留在了毛上面，所以松狮清理起来最麻烦的就是沾满口水的嘴巴。刚洗完澡没多久的松狮可能过一会嘴角又会是沾满口水，所以松狮嘴角的的毛最好经常修一修。', 'feedPoints': '因为松狮不喜欢运动，所以对于事物的需求量也并不是特别的大，每天可以给它喂两顿而且不用太多。对于松狮来说皮肤其实并不是特别好，很容易引起皮肤病，所以自己做', 'imageURL': ['http://www.boqii.com/entry/photo/427/0', 'http://www.boqii.com/entry/photo/427/1295', 'http://www.boqii.com/entry/photo/427/1296', 'http://www.boqii.com/entry/photo/427/1297', 'http://www.boqii.com/entry/photo/427/1298', 'http://www.boqii.com/entry/photo/427/1299']} ``` ##### 5.猫猫详细信息搜索 输入 ``` import requests key ="5AGZczH538c065ca18b2353370bb64384a85237067281d1" def catmessage(apikey,petID): url = 'https://api.apishop.net/common/catFamily/queryCatInfo' params = {"apiKey":key, "petID":petID } r = requests.get(url, params=params) results = r.json()['result'] return results petID='30' catmessage(key,petID) ``` 输出 ``` 'petID': 30, 'name': '科拉特猫', 'engName': 'Korat', 'character': '文静，给人以尊贵、内向的感觉。', 'nation': '泰国 ', 'easyOfDisease': '肠胃疾病', 'life': '10--15岁', 'price': '10000以上', 'des': '1959科拉特猫的体毛和俄罗斯蓝猫、夏多流猫一样，没有浓淡、没有，清一色蓝色。由于没有下层毛的缘故，和体表密着，有像丝一样光泽。同时，一根根毛之间有银灰色插入，可反射光线，使得全身散发出银色的光芒。科拉特原产泰国西北部的考拉特高原，是一个古老品种。此种于年由泰国引入美国，并于年得到美国爱猫者的公认。年后英国方才承认这种猫。又称为，是以其原产地泰国一个省的名字命名，在当地被称为“西塞瓦特”，意为吉祥如意。泰国人常送新娘一对这种代表吉庆的猫作为结婚的传统贺礼。科拉特猫的体毛和俄罗斯蓝猫、夏多流猫一样，没有浓淡、没有斑纹，清一色蓝色。由于没有下层毛的缘故，和体表密着，有像丝一样光泽。同时，一根根毛之间有银灰色插入，可反射光线，使得全身散发出银色的光芒。另外，科拉特猫的另一特色，就是其他猫所没有的心型脸。耳朵大，前端略带圆状，是位于头部较高的位置。绿色的眼睛。又大又圆，稍稍突出。在所有猫之中，拥有最古老的克拉原产地是在泰国西北部的考拉特高原。自古以来泰国人就相信猫能带来幸福，特别是在上流社会中，更被人们所珍重。', 'feature': 'Korat科拉特猫的原产地是泰国，别名：柯拉特、、，英文名：。科拉特猫身材匀称，体格健壮，毛色很独特。平时比较喜欢黏着主人，主人在家陪伴的时候喜欢趴在主人的膝盖上玩耍，是不错的伴侣。：半像矮脚马型，肌肉发达。为鸡心形。：大，尖呈圆弧形。：大而圆，呈晶莹的绿色。：鼻短。：长度适中。：脚爪小，为椭圆形。：长度适中。：毛短而有光泽。：为银蓝色。', 'characterFeature': '科拉特猫的\n科拉特猫的性格\n柯拉特猫比较文静，给人以尊贵、内向的感觉。叫声很轻，十分温和，喜欢和人接近。它的智商很高，稍加训练就可以学会拣拾玩具或用双腿走路。考拉特猫与主人的关系亲密，是完美的伴侣动物。科拉特猫生机勃勃，活跃，灵活而贪玩，但不喜滋事喧哗，它需要安静的环境。它对其它猫不友好，对陌生人不信任。它温柔，感情非常丰富，非常敏感，对主人很依恋。需要爱和关注。有着乐音般的嗓子。', 'careKnowledge': '科拉特猫是非常好养的猫咪，它不挑食，没有异食癖，平时的养护也很好打理。科拉特猫属于短毛猫，不像长毛猫掉毛那么厉害，洗澡也比较方便。如果主人在家有时间的话完全可以在家里帮猫咪洗澡，又干净又能亲自帮猫咪洗澡享受乐趣，岂不是一举两得，如果您现在闲着，快快动手吧！', 'feedPoints': '科拉特猫是肉食动物，其实所有的猫咪都爱吃肉，肉类和', 'imageURL': ['http://www.boqii.com/entry/photo/388/0', 'http://www.boqii.com/entry/photo/388/3949', 'http://www.boqii.com/entry/photo/388/3948', 'http://www.boqii.com/entry/photo/388/3947', 'http://www.boqii.com/entry/photo/388/3946', 'http://www.boqii.com/entry/photo/388/3945']} ``` ##### 6.植物详细信息搜索 输入 ``` import requests key ="5AGZczH538c065ca18b2353370bb64384a85237067281d1" def plantmessage(apikey,plantID): url = 'https://api.apishop.net/common/plantFamily/queryPlantInfo' params = {"apiKey":key, "plantID":plantID } r = requests.get(url, params=params) results = r.json()['result'] return results plantID='133' plantmessage(key,petID) ``` 输出 ``` {'alias': '荷木、木艾树、何树、柯树、木和、回树、木荷柴、横柴', 'binomiaNomenclature': 'Schima superba', 'botanicalName': '木荷', 'careKnowledge': '\u3000\u3000\u3000\u30001、育苗地选择选择地势平坦，排水良好，土层深厚疏松的酸性沙壤土作圃地。在排水不良的圃地，\u3000\u30002、整地、施肥圃地要深耕翻土，使土壤充分风化。施足基肥，用混合\u3000\u30003、播种多采用春播，高床，条播，行距20。25cm，播幅10－－15cm，每亩播种量2.5－3kg。幼芽出土力弱，覆土不宜过厚，以0.5cm左右为宜，覆土材料以轻松的沙壤或火烧土为好，要盖一层薄草。\u3000\u30004、苗期管理播后2－3周即可发芽，约半数幼苗出土时揭草，搭设荫棚以防日灼和早害，遮阳', 'class': '双子叶植物纲', 'des': '\u3000\u3000 \u3000\u3000木荷为大乔木，高25米，嫩枝通常无毛。花生于枝顶叶腋，常多朵排成总状花序，直径3厘米，白色，花柄长1－2.5厘米，纤细，无毛；苞片2，贴近萼片，长4－6毫米，早落；萼片半圆形，长2－3毫米，外面无毛，内面有绢毛；花瓣长1－1.5厘米，最外1片风帽状，边缘多少有毛；子房有毛。蒴果直径1.5－2厘米。花期6－8月。', 'engName': 'Schima superba Gardn. et Champ.', 'family': '山茶科', 'feature': '\u3000\u3000', 'genus': '木荷属', 'imageURL': ['http://www.boqii.com/entry/photo/2169/0', 'http://www.boqii.com/entry/photo/2169/5359'], 'kingdom': '植物\u3000', 'latinName': 'Schima superba Gardn. et Champ.', 'name': '木荷', 'order': '侧膜胎座目', 'phylum': '被子植物门', 'plantID': 30, 'species': '木荷种'} ​ ``` ##### 7.[完整代码测试](https://gitee.com/edithx/api_qimo/blob/master/API%E8%B0%83%E7%94%A8.ipynb) ### 六、心得总结 #### 1. 同行/同侪参考价值 API的使用其实是站在站在巨人的肩膀上的，只需要遵守接口的规则就能轻松调用，重要的是如何更好地抓住市场、用户的痛点进行项目的构思，还有对于技术文档的阅读和理解，以及怎么改善该应用成为真正的一个功能，在已经拥有一个想法的情况下，我们需要做的只是把这个想法加以修饰并实践出来。 #### 2. 对同行/同侪成果的尊重引用 在文档的最后，依然要诚挚感谢对这个项目提供帮助的许智超老师以及游鸽老师，在他们一个学期的教学上，我在代码以及api运用的进度从无到有，也要感谢同学们在课后对我的指导。同时需要感谢aipshop平台提供的智能API功能调动，墨刀的交互流程图制作的功能以及ProcessOn的制作流程图功能等等，再次表示我衷心的感谢！ #### 3.引用感谢 1.[apishop](https://www.apishop.net/#/) 2.[墨刀](https://modao.cc/) 3.[PROCESSON](https://www.processon.com/) #### 4.[秘密花园PPT](https://gitee.com/edithx/api_qimo/blob/master/%E7%A7%98%E5%AF%86%E8%8A%B1%E5%9B%AD.pptm) #### 5.[20*20投影片ppt视频解说](https://www.bilibili.com/video/BV1wt4y167a3/) 在规定时间6分40秒内