在spring-rest文档中记录自定义注释



我必须在遗留项目中集成spring-rest文档,因为它们使用了一堆自定义注释(例如用户角色(。在spring-rest文档中有没有一种方法来记录这个注释?

Spring REST文档在HTTP请求和响应级别工作。在设计上,它对注释、如何处理这些请求和创建响应一无所知。这样可以确保您所记录的内容与客户端通过HTTP与您的服务交互处于同一级别。

如果您想包含关于@PreAuthorize的信息或与之类似的注释,则必须自己编写一些内容才能做到这一点。如果你想适应REST文档的工作方式,你可以实现一个自定义的Snippet,它配置了一个类或方法,它使用反射从中提取注释,并从中生成一些文档。

最新更新