REST API - ALPS UI(Swagger UI之类)

时间:2015-12-17 09:01:01

标签: rest documentation swagger spring-data-rest

我现在正在评估Spring Data REST,我真的很喜欢它。

我缺少的是与Swagger UI类似的精美呈现,交互式文档可能性。

我知道Spring Data REST不是静态API而且有HAL Browser,但不幸的是HAL浏览器没有显示任何关于相应url / GET / POST的文档元数据 /等

Spring Data REST生成ALPS元数据(参见here)。

为什么需要这样做?
嗯,对于前端开发人员而言,从我的角度来看,这对于提高工作效率非常有用。此外,每种自动生成的文档都可以节省大量时间。

长话短说:
是否有“ 用于ALPS /超媒体感知REST API的Swagger UI ”?

其他信息:
我已经找到了一个描述问题的similar question,但我不确定它是否可以重新加入,所以我创建了这个新的。也许在此期间有可能的解决方案。

1 个答案:

答案 0 :(得分:3)

this放入您的依赖项并吸烟:

<dependencies>
    <dependency>
        <groupId>org.springframework.data</groupId>
        <artifactId>spring-data-rest-hal-browser</artifactId>
    </dependency>
</dependencies>

引用于:/ api / browser

我今天只是在寻找同样的事情。 ALPS是元数据 - 但是SRD会产生hal - 所有你需要的东西都可以导航HAL数据而你已经完成了。