微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

java – 如何用Spring自我描述REST api?

我正在使用spring-mvc来创建像这样的servlet:

@RestController
public class MyServlet {
   @GetMapping("/test")
   public MyRsp test(MyReq req) {
         //...
   }
}

现在,如果用户访问我的应用程序localhost:8080 / my-app的根目录,它应该显示可用的GET和POST方法列表.最好使用可能的输入参数,可接受的标题等.

问题:是否可以使用任何弹簧框架,如HATEOAS?

我希望有一个框架来自动检测任何@RestController和包含的方法.

或者我是否必须自己创建该概述页面

最佳答案
Swagger 2是另一种选择.阅读以下内容以了解有关swagger以及如何设置的更多信息.

Setting Up Swagger 2 with a Spring REST API

您还可以为其余api创建swagger定义,客户端可以使用它来生成客户端类.

此外,swagger ui可用于测试/调用您的API. swagger提供了一个用户界面,您可以在其中输入所有api输入,例如查询参数,路径参数,请求正文,标题.

Sample Swagger UI

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 [email protected] 举报,一经查实,本站将立刻删除。

相关推荐