newsInfo


URI

<newsInfos_uri>/{id}[.<format>]

支持的方法

GETPUTHEAD

父资源

newsInfos

介绍

newsInfo 资源是单个新闻条目的信息,支持获取单个新闻条目的详情,支持更新单个新闻条目。

支持的方法:

支持的表述格式:RJSON、JSON、XML。

资源层次

HTTP 请求方法

对如下 URI 执行 HTTP 请求,以 rjson 输出格式为例加以说明,其中,supermapiportal 是服务器名。

http://supermapiportal:8190/iportal/web/news/{id}.rjson

GET 请求

获取由 id 指定的新闻的基本信息。

响应结构

对 newsInfo 资源执行 GET 请求,返回的资源表述结构如下:

字段 类型 说明
thumbnail String 新闻的缩略图。
visitCount Integer 新闻的访问量。
createTime Long 新闻创建时间。
updateTime Long 新闻更新时间。
id Integer 新闻的唯一标识符。
source String 新闻来源。
published Boolean 新闻是否已发布。
title String 新闻标题。
category String 新闻的类别。
userName String 新闻创建者。
content String 新闻的内容。
nickname String 新闻创建者的昵称。

响应示例

对 newsInfo 资源:http://localhost:8190/iportal/web/news/928867994.rjson 执行 GET 请求,返回的 rjson 格式响应结果如下:

{

  "thumbnail": null,

  "visitCount": 8,

  "createTime": 1600064805362,

  "nickname": "admin",

  "updateTime": 1600064805362,

  "id": 928867994,

  "source": "企划部",

  "published": true,

  "title": "会议通知",

  "category": null,

  "userName": "admin",

  "content": "9月15日下午三点在一号会议室召开部门例会,请大家按时参加,不得缺席。"

}

PUT 请求

更新由 id 指定的新闻条目的详情。

请求参数

发送请求时,需要在请求体中传递如下参数:

名称 类型 含义
thumbnail String 新闻的缩略图。
source String 新闻来源。
published Boolean 新闻是否已发布。
title String 新闻标题。
category String 新闻的类别。
content String 新闻的内容。

响应结构

返回的资源表述结构如下:

字段 类型 说明
succeed boolean 新闻更新是否成功。
error Httperror 出错信息,如果新闻更新成功,则没有本字段。

响应示例

对 newsInfo 资源:http://localhost:8190/iportal/news/928867994.rjson 执行 PUT 请求,将新闻标题由“会议通知”更新为“会议2号通知”,发送请求体如下:

{

    "thumbnail": null,

    "source": "企划部",

    "published": true,

    "title": "会议2号通知",

    "category": null,

    "content": "9月15日下午三点在一号会议室召开部门例会,请大家按时参加,不得缺席。"

}

则返回的 rjson 格式响应结果如下:

{"succeed": true}

HEAD 请求

返回跟 GET 请求一样的 HTTP 响应头,但是没有响应实体。可以在不必传输整个响应内容的情况下,获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型,字符编码,压缩编码,实体内容长度等。

HEAD 请求可以用来判断 newsInfo 资源是否存在,或者客户端是否有权限访问 newsInfo 资源。通过对加.<format>的 URI 执行 HEAD 请求,还可以快速判断 newsInfo 资源是否支持<format>格式的表述。

请参见