返回生成application / json的web API中的简单字符串

时间:2017-03-23 16:20:40

标签: java json api jersey jax-rs

在规范中,API的答案是一个简单的字符串值,但格式为JSON。

我正在使用泽西岛。

如果我像这样构建我的答案:

return Response.ok().entity("hello").build();

它正在运行,但是例如,在Firefox的网络视图中,当我查看答案时,会出现JSON语法错误。 如果我对字符串有一些双引号:

return Response.ok().entity("\"hello\"").build();

Firefox中没有语法错误,但我认为这不是一个好方法。

有一种很好的方法可以为生成一些JSON的API返回一个简单的String值吗?

1 个答案:

答案 0 :(得分:2)

如果您要生成JSON,则必须返回一些Object或Collection,例如:

Hello.java

public class Hello{
  public String name;
  // getter setter
}
YourRest.java中的

@GET
@Path("hello/{name}")
@Produces(MediaType.APPLICATION_JSON)
public String greeting(@PathParam("name") String name ){
  Hello hello = new Hello();
  hello.setName(name);
  return Response.ok().entity(hello).build();
}

@GET
@Path("people")
@Produces(MediaType.APPLICATION_JSON)
public ArrayList<String> peopleList(){
  List<String> people = new ArrayList<String>();
  Hello hello = new Hello();
  hello.setName("bloub");
  people.add(hello);
  hello.setName("Aime");
  people.add(hello);
  return Response.ok().entity(people).build();
}

http://localhost:8080/hello/bloub将返回

{
"name" : "bloub"
}

http://localhost:8080/people将返回

[
  {
    "name" : "bloub"
  },
  {
    "name" : "Aime"
  }
]

但如果您想要返回简单文字,请使用@Produces(MediaType.TEXT_PLAIN)

例如:

YourRest.java中的

@GET
@Path("hello/{name}")
@Produces(MediaType.TEXT_PLAIN)
public String greeting(@PathParam("name") String name ){
  return Response.ok().entity("Hello, "+name).build();
}

http://localhost:8080/hello/bloub将返回

Hello, bloub

希望有所帮助