Swagger和RESTful spring hateoas资源

Question

在我的RESTful API中,所有资源都在扩展Spring的ResourceSupport基础,以便通过设计确保hateoas主体.例如:

public class PoolResource extends ResourceSupport {
    private String name;
    ...
}

我也在使用Swagger,我想知道:是否有可能以某种方式配置swagger-ui,忽略来自ResourceSupport的属性？

(Swagger-ui提供了一个很好且简单的API前端.作为使用Swagger的主要好处之一,API易于理解,并为那些甚至不熟悉REST API的人使用API​​.只要"链接"和"相关"进入图片.)

Answer 1

我建议扔掉招摇,并使用像邮差这样的休息客户.Postman使spring-hateoas提供的链接可以点击,因此您可以很快地浏览API.如果要提供一些其他信息/文档,可以将这些请求保存到Postman中的请求集合中并将其导出以进行分发.在我为rest apis尝试了几个文档工具之后,包括raml,swagger,apiary以及最后的postman-collections与hateaos的组合,我发现后者是我最满意的.

Answer 2

隐藏它的唯一合理的方法是对模型本身隐藏它（有几种方法可以做到这一点，但如果您使用 Spring MVC，我不确定 swagger-springmvc 支持什么）。

理论上你可以破解 swagger.js 来隐藏它，但这完全是一场冒险。