前提条件

以下 api 路径均以 http://47.100.175.62:3000/api/v1 为前缀

主题相关的接口

get /topics 主题首页

接收 get 参数

  • page Number 页数。默认第1页。
  • tab String 主题分类。目前有 ask share job good 选择其中的一个，如果不添加此参数，默认是所有分类。
  • limit Number 每一页的主题数量 最大值为50，超过50按50计算，如果不写，默认为20条数据。
  • mdrender String 当为 false 时，不渲染。默认为 true，渲染出现的所有 markdown 格式文本。

get /topic/:id 主题详情

接收 get 参数

  • mdrender String 当为 false 时，不渲染。默认为 true，渲染出现的所有 markdown 格式文本。
  • accesstoken String 当需要知道一个主题是否被特定用户收藏以及对应评论是否被特定用户点赞时，才需要带此参数。会影响返回值中的 is_collect 以及 replies 列表中的 is_uped 值。

如何做？

上面拿到的接口文档 比较简陋，写的并不是非常清楚。

基本操作

根据文档

  1. 先拼接请求的路径，比如第一个接口， 要将请求的前缀和路径放在一起。

image.png

  1. get 请求 文档中的请求参数没有说明放在 请求的body 或者 header 或者 quary params ，文档中都没有说明。

如果get请求没有特意说明，一般默认请求的参数都放在 query params。
请求参数有默认值，可以不写。
image.png

  1. 添加参数，可以将参数添加到 【Query Params】

image.png
因为参数有默认值，可以不必把所有的参数都添加进来。

  1. 当做第2个接口的时候，请求的路径中 /topic/:id :id 表示的是一个具体话题id值。 因为每个话题id都不一样。这个id需要从第一个接口的返回结果中获取。

image.png
在postman中可以这样做，复制第一个接口结果中的id
image.png

练习

上面两个接口中的路径都使用到 http://47.100.175.62:3000/api/v1 ，请将此值设置为变量，并在postman 引用变量。
image.png
引用变量，将原来的值替换为变量来使用。
image.png

表单格式接口

post /topics 新建主题

请求Body
数据格式：x-www-form-urlencoded (表单格式)

  • accesstoken String 用户的 accessToken。
  • title String 标题， 不能少于10个字
  • tab String 目前有 ask share job ，只能选择其中之一
  • content String 主体内容， 不能为空

用户登录成功之后，可以在 http://47.100.175.62:3000/setting 中看到自己的token值
image.png
这里提供一个可使用的token
2d4f12f4-06dc-4cb7-aef2-884b346d745e

使用Postman进行操作，在 【Body】—【x-www-form-urlencoded】中输入对应请求数据。
image.png

Json 格式的接口

post /topics 新建主题

请求Body
数据格式：JSON

  • accesstoken String 用户的 accessToken。
  • title String 标题， 不能少于10个字
  • tab String 目前有 ask share job ，只能选择其中之一
  • content String 主体内容， 不能为空

操作

在postman中如果指定请求的数据格式为json

  1. 选择【body】—【raw】—【json】

image.png

  1. 很多文档中 json的值都已经写好，我们只需要复制改里面的值即可。但是现在的文档中没有，需要自己手写json， json字段的格式为下面

    1. {
    2.  "accesstoken":"",
    3. "title":"",
    4.  "tab":"",
    5. "content":""
    6. }

    注意：

    1. json格式中的字符串都必须使用 双引号
    2. 字段之间使用逗号隔开，最后一个字段前不需要添加逗号

image.png

post /topics/update 编辑主题

接收 post 参数

  • accesstoken String 用户的 accessToken
  • topic_id String 主题id （必须是自己新建主题的id）
  • title String 标题
  • tab String 目前有 ask share job
  • content String 主体内容

image.png

总结

  1. 当接口文档不是特别齐全的时候。
    1. get 请求的请求参数没有特别说明，请求参数 放在 【Query Params】
    2. Post请求 参数没有特别说明的时候，一般为 x-www-form-urlencoded， json格式，具体可以请教下开发。
  2. json格式编写的时候注意事项：
    1. 字符串都是使用 双引号
    2. 字段之间使用 逗号隔开，最后一个字段后面没有 逗号

作业：

  1. http://47.100.175.62:3000/api 上面的所有的接口使用postman 做一遍