我有一个基于jhipster的Spring项目,该项目在前端使用yarn / angular,在背面使用Spring。我正在尝试弄清楚如何自定义招摇页面。当前,它使用swagger-ui自动填充新API,这很好,但是我需要向这些API添加更多自定义信息,因此是我的问题。
但是我对正在大肆宣传的东西感到困惑。看起来好像有一个名为swagger-ui-dist的节点包,我还看到一个src / main / webapp文件夹和一个swagger-ui文件夹,其中包含index.html页。
我想我最想用的是用能读取可使用Swagger编辑器在线创建的文件的swagger替换当前的swagger-ui自动设置。
抱歉,我希望是一些简单的问题。我是swagger和npm / yarn的新手。
谢谢
答案 0 :(得分:0)
因此,在进行了更多研究之后,我发现您可以创建自己的OpenAPI文档,但是在Spring中更简单的方法是使用@APIOperation批注来批注端点方法。还有其他一些大张旗鼓的特定注释。
在参数中,您可以提供value =“”,notes =“”以及许多其他自定义值,这些值将阐明您的API在Swagger中的作用。然后在打开您的摇摇欲坠页面时,摇摇欲坠会自动将其填充。
我希望对遇到同样问题的任何人都能有所帮助。