swagger-bootstrap-ui的使用说明

有些朋友在使用这个jar包的时候会出现接口出不来的状况,或者只出现ui默认的几个接口,项目的api接口没有出来,html

这里有些注意点同你们说一下吧java

  • 依赖swagger(这点很重要),因此项目必须启用swagger,若是你的项目原来就是使用swagger的,仅仅只须要引入swagger-bootstrap-ui的jar包,而后访问/doc.html页面便可,相似于访问原生的/swagger-ui.htmlgit

  • swagger-bootstrap-ui仅仅只是ui包,没有特定的api语法,属于工具性质的,是彻底依赖于swagger的,后端代码也须要使用swagger的java注解-来实现bootstrap

  • swagger-bootstrap-ui作的工做就是解析swagger的接口/v2/api-docs,根据该接口作的界面呈现,由于做者喜欢左右风格的布局,原生的ui布局是上下结构的,对于做者来讲不是很方便,因此就写了这个小工具,开源出来给你们使用,若是你也喜欢这种风格,你能够应用到你的项目中后端

  • git上也提供了一个demo,能够pull下来运行一下,地址:swagger-bootstrap-ui-demoapi

若是出现js报错,接口出不来,欢迎新建issue告知做者修正,很是乐意解决您遇到的bug工具

固然若是你也有更好的想法,欢迎沟通,一块儿来完善这个小工具~~~~~布局

相关文章
相关标签/搜索