使用Spring HATEOAS将枚举公开为REST API的正确方法是什么（通过Spring Data REST）

Question

我正在尝试将HATEOAS与Spring HATEOAS一起使用，并且需要将enums公开为带有Spring HATEOAS的REST API。

我尝试了以下三种方式：

@RestController
@RequestMapping(path = "/fruits")
public class FruitResourceController {

    @RequestMapping(method = RequestMethod.GET)
    public Fruit[] fruits() {
        return Fruit.values();
    }

    // NOTE: The `produces` attribute is only for browsers.
    @RequestMapping(path = "/with-resource", method = RequestMethod.GET,
            produces = MediaTypes.HAL_JSON_VALUE)
    public Resource<Fruit[]> fruitsWithResource() {
        Resource<Fruit[]> resource = new Resource<Fruit[]>(Fruit.values());
        Link selfLink = linkTo(methodOn(FruitResourceController.class).fruitsWithResource())
                .withSelfRel();
        resource.add(selfLink);
        return resource;
    }

    // NOTE: The `produces` attribute is only for browsers.
    @RequestMapping(path = "/with-resources", method = RequestMethod.GET,
            produces = MediaTypes.HAL_JSON_VALUE)
    public Resources<Fruit> fruitsWithResources() {
        Resources<Fruit> resources = new Resources<Fruit>(Arrays.asList(Fruit.values()));
        Link selfLink = linkTo(methodOn(FruitResourceController.class).fruitsWithResources())
                .withSelfRel();
        resources.add(selfLink);
        return resources;
    }

}

但是我不知道哪个是HATEOAS的正确方法。任何建议或参考都将不胜感激。

作为参考，我有以下Spring Data REST配置：

@Configuration
public class SpringDataRestConfig {

    @Bean
    public ResourceProcessor<RepositoryLinksResource> repositoryLinksResourceProcessor() {
        return new ResourceProcessor<RepositoryLinksResource>() {
            @Override
            public RepositoryLinksResource process(RepositoryLinksResource resource) {
                Link fruitsLink = linkTo(methodOn(FruitResourceController.class).fruitsWithResources())
                        .withRel("fruits");
                resource.add(fruitsLink);
                return resource;
            }
        };
    }

}

请参见以下示例项目：

https://github.com/izeye/spring-boot-throwaway-branches/blob/data-jpa-and-rest/src/main/java/com/izeye/throwaway/SpringDataRestConfig.java https://github.com/izeye/spring-boot-throwaway-branches/blob/data-jpa-and-rest/src/main/java/com/izeye/throwaway/FruitResourceController.java

---更新日期：2016.01.04

使用ALPS（/profile）获得枚举列表看起来不错，但我不确定这是一种正确的方法。

Answer 1

HATEOAS的轮廓看起来是正确的地方。但是当你手里拿着锤子时，一切看起来都像钉子。

数据验证不是HATEAOS规范的一部分，您不应该尝试“用锤子粉刷墙壁”。

您最好使用为此而设计的解决方案；窗体。我应该研究JSON-Schema及其扩展Json-Forms。

https://jsonforms.io/

这是通过UI定义数据输入的标准化解决方案。只是代码endpoint释义HATEAOS命名约定

/表单/${entityname}

作为 /profile的扩展/替代，您可以很容易地修改Spring以将其包含到根的HATEOAS“_links”中

返回同名实体的硬编码JSON表单模式。您还可以使用交叉连接半自动执行此操作，以便它只返回当前实体的匹配键/字段。所以，若实体发生变化，它不会完全破坏您的UI。然后，您可以使用大量代码实现全自动，这些代码通过反射读取实体类，并自动为您的实体生成JSON表单模式定义。

就像这个Java的伪代码

entity.getFields().forEach(
  if (isEnumeration(field)) {
     sb.append( 
         field.getName() + ": {"
         + "type: string,"
         + "title: " + localize(field.getName() + ","
         + "enum: " Arrays.toString(field.values()) + ","
         + "required: " isNullable(field) 
         + "    },"
     );
    continue; 
  );
  if (isString(field)) {
    ...

您自己的数据模式的约束是可行的。如果您的代码