Postman 在使用 REST Api 时出现意外的“S”答案

【问题标题】：Unexpected 'S' in Postman on consuming REST ApiPostman 在使用 REST Api 时出现意外的“S”
【发布时间】：2017-11-14 15:31:47
【问题描述】：

我在 SpringBootApplication 中编写了非常基本的 REST 服务。当我尝试点击 api 时，我收到了类似 Unexpected 'S'

的回复

这是我的 api，

@RestController
    @RequestMapping(value="/rally")
    public class CreateProjectApi {

        @RequestMapping(value = "/createProject", 
                produces = { "application/json" }, 
                consumes = { "application/json" }, 
                method = RequestMethod.GET)
        public ResponseEntity<String> createProj() {
            String s = "Success...";
            return new ResponseEntity<String>(s, HttpStatus.OK);
        }

    }

这是我的 POM.XML，

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.altimetrik.rally</groupId>
    <artifactId>RallyRestApi</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>RallyRestApi</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.4.RELEASE</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <!-- Setup Spring MVC & REST, use Embedded Tomcat -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>com.rallydev.rest</groupId>
            <artifactId>rally-rest-api</artifactId>
            <version>2.2.1</version>
        </dependency>
</dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

我通过邮递员在标题中使用content-type:application/json 来访问api。但我得到了 Unexpected 'S' 作为回应。我已经关注了这个链接unexpected 's' in response of restful service，但我没有从中得到任何解决方案。谁能帮我解决这个问题？

【问题讨论】：

那是因为您的响应不是 JSON 格式并且您指定您将生成 JSON，错误意味着它应该是 { 签名，因为它 iexpected JSON but he found S character
如何以 JSON 格式做出响应？ @user7790438
@Nithyananth 您的响应需要是一个对象或一个集合/数组，然后由 Spring 在类路径中找到的转换器序列化。如果您真的只是希望您的回复是文本 Success...，那么这不是 JSON，您可以将您的回复类型更改为 "text/plain"。此外，由于您的服务不接受任何参数，因此您实际上并不需要 RequestMapping 中的 consumes 参数。
我想返回"JSON"，所以你能给出示例代码应该是怎样的吗？ @nbrooks
要么删除生产元素，要么将响应媒体类型设为 JSON。

标签： java json rest maven spring-boot

【解决方案1】：

正如 user7790438 和 nbrooks 在 cmets 中所解释的那样，问题是您的响应将是纯文本 (Success...)，即使您告诉它加载 JSON（通过提供 Content-Type: application/json 标头)。

要返回 JSON，你应该返回某种对象，例如，你可以像这样创建一个 ProjectStatus 类：

public class ProjectStatus {
    private String status;

    public ProjectStatus(String status) {
        this.status = status;
    }

    public String getStatus() {
        return status;
    }
}

现在，在您的 REST 控制器中，您应该返回一个 ResponseEntity<ProjectStatus>，如下所示：

return new ResponseEntity<ProjectStatus>(new ProjectStatus("Success..."), HttpStatus.OK);

当您使用 Postman 时，这将产生以下 JSON：

{"status": "Success..."}

您几乎可以返回任何您想要的对象。一个示例是在您的响应中返回创建的项目。

或者，如果您不需要 JSON，您可以提供 Content-Type: text/plain 标头。

【讨论】：