👉 开发前请看这里!!!

# 开发说明 ## 1. 文档说明 大多数情况下,文档将参数已经将参数说明得很清楚了,这里强调不能直接测试的情况: - **URL路径变量**(path variable)采用“{}”的方式,测试时需要手动替换,不能直接请求,这个变量区别于测试板块的“URL参数”,及问号后面的参数(e.g. info?mode=xxx) ![image.png](https://cos.easydoc.net/97788718/files/kzbfpmby.png) - 使用**post请求**是的json体用form-data会出现问题,可以勾选raw后在点击自动生成json,选择合适的参数并填入即可 ![image.png](https://cos.easydoc.net/97788718/files/kzbfu7tf.png) ## 2. 在线文档快速调试使用帮助: ### 2.1 URL 手册需要收费才能自动填域名,所以需要手动补充,目前的测试地址是 http://120.24.191.224/ ,也可以通过如下方式快速进参数和域名的自动补充 也可以通过两个变量来替换对应的域名 测试环境`{{host_test}}` 正式环境`{{host_pro}}` - 点击文档此处 ![image.png](https://cos.easydoc.net/97788718/files/kzbg41vt.png) - 点击测试的历史记录![image.png](https://cos.easydoc.net/97788718/files/kzbg53r0.png) ### 2.2 常用变量添加 token设计时,有效期为1天;由于大部分业务需要认证才能进行操作,很多请求头参数都包含,避免频繁填写可以有以下两种示例方式 - 添加全局变量![image.png](https://cos.easydoc.net/97788718/files/kzbgzxrt.png) 使用时用“**{{}}**”填入自定义的变量名替换即可,如图 ![image.png](https://cos.easydoc.net/97788718/files/kzbh1yyg.png) - 添加常用参数 ![image.png](https://cos.easydoc.net/97788718/files/kzbh3aue.png) ## 3. 错误说明 当响应码如果为500时,除了 1. **获取模型的数据**:请重试(可能是redis数据库断连),其他如果遇到情况; 2. 选择**不同模式**(mode),由于测试服务器内存有限,只支持virus_cell 其他情况,请联系后端及时修改bug,如可能请尽量在gitee提交issue(方便文档记录,避免遗漏,也可跟踪是否及时解决),++截图报错信息;填写接口和填入参数;指派负责人;勾选优先级;尽可能描述遇到的情况++ ![image.png](https://cos.easydoc.net/97788718/files/kzbgrcqn.png) 附:[提交issue地址](https://gitee.com/LStriving/iShiner/issues) [加入gitee仓库的地址](https://gitee.com/LStriving/iShiner/invite_link?invite=fbd00ec3a80af3eefa61225874dff7b54f20c4b7b81e20f1b7993663152babc55eeeb51c0a9e10a62f846e2b589479b3)(链接失效请联系管理员) ## 4.用户的在线管理 由于涉及到服务限制了用户使用个别接口的次数,导致可能次数用完,测试不到想要的结果,可以在[admin界面](http://120.24.191.224/admin)登录 ``` username: iShiner password: scut_iShiner123456 ``` 在usercenter里选择自己想要添加服务次数的用户名手动添加次数 ![image.png](https://cos.easydoc.net/97788718/files/kzc7x4gu.png)