yapi/doc/page/usage/quickstart.md

52 lines
1.8 KiB
Markdown
Raw Normal View History

2017-09-13 17:51:57 +08:00
### 如何创建接口?
2017-08-21 21:18:55 +08:00
2017-09-05 17:06:50 +08:00
把大象装进冰箱分几步?三步:把冰箱门打开,把大象装进去,关门,搞定~
2017-08-31 11:55:24 +08:00
2017-09-05 17:06:50 +08:00
新建接口分几步?也是三步:
2017-08-21 21:18:55 +08:00
2017-09-06 10:36:11 +08:00
* [获取权限](#获取权限)
2017-09-05 17:06:50 +08:00
* [找到一个项目](#选择项目)
2017-09-13 11:55:53 +08:00
* [新建接口](#新建接口)
2017-08-21 21:18:55 +08:00
2017-09-05 17:06:50 +08:00
搞定~
2017-08-21 21:18:55 +08:00
2017-09-06 10:36:11 +08:00
## 获取权限
2017-08-31 11:55:24 +08:00
2017-10-13 14:37:37 +08:00
新用户登录拥有 `个人空间` 分组下的全部权限,个人空间分组仅自己可见,因此可以在这里任意试用 YApi 的功能。
2017-08-21 21:18:55 +08:00
2017-10-13 14:37:37 +08:00
除此以外没有任何项目或分组的权限,只能浏览已存在分组下面的公开项目。
如果找不到想找的项目,可能是尚未成为项目成员,此时应联系 `项目组长` 将你加入该项目。
2017-09-13 17:51:57 +08:00
2017-09-21 15:14:41 +08:00
[怎样联系组长?](./qa.html#Q__怎样联系组长)
2017-09-13 17:51:57 +08:00
<img src="./images/usage/manage_ask.png" />
2017-09-21 15:14:41 +08:00
- 想创建分组,请看: [创建分组](./manage.html#创建分组)
- 想创建项目,请看: [创建项目](./manage.html#创建项目)
2017-09-13 17:51:57 +08:00
2017-09-21 15:14:41 +08:00
> 想了解更多权限信息,请查看[权限列表](./manage#权限列表)
2017-09-13 11:55:53 +08:00
2017-09-05 17:06:50 +08:00
## 选择项目
- 如果你已经登录,会在首页右侧看到一些项目 (可以在左侧的分组列表切换分组来查看不同分组下的项目)。
- 点击一个项目,进入该项目的详情页。
2017-08-24 16:37:45 +08:00
<img src="./images/project_list.png" width = "800" style="margin:0px auto;display:block;" alt="图片名称" align=center />
2017-08-21 21:18:55 +08:00
2017-09-05 17:06:50 +08:00
## 新建接口
- 点击左侧接口分组右侧的菜单按钮,选择 `添加接口`,或者点击接口列表右上角的 `添加接口`
2017-08-21 21:18:55 +08:00
2017-09-05 17:06:50 +08:00
<img src="./images/usage/api_add_btn.png" />
2017-08-21 21:18:55 +08:00
2017-09-05 17:06:50 +08:00
- 选择接口分类,输入接口名称和接口路径,点击 `提交`
2017-08-21 21:18:55 +08:00
2017-09-05 17:06:50 +08:00
<img src="./images/usage/api_add_panel.png" />
2017-09-06 10:36:11 +08:00
- 恭喜你创建了第一个YApi的接口你可以看到在左侧看到接口名称右侧有该接口的信息预览。
2017-08-21 21:18:55 +08:00
2017-09-06 10:36:11 +08:00
<img src="./images/usage/api_res.png" />