swagger构建restful风格api

前言

        在开发过程中,有没有感觉到api过多,文档难写,难测试?来看看怎么在spring mvc中,使用swagger构建restful风格api文档,祝你早日释放自己

集成步骤

1,首先在pom.xml文件中,添加swagger2包

 

2,查看web.xml文件中的DispatcherServlet,过滤的路径是否为“/”,如果不是,需要添加下面的配置

3,添加配置类SwaggerConfig,确保这个类在spring扫描的路径内,内容如下:

 

4,修改api的注解,案例如下:

类头:

 

方法:

5,在项目webapp下面新建文件夹swagger,然后到github中copy swagger-ui的前端页面,位于目录dist。把整个文件夹的内容都copy过来,删除里面的.map测试数据。

6,打开文件夹里的index.html文件,修改里面的url,示例如下:

7,启动项目,在项目的启动日志中的/v2/api-docs就是swagger2生成的api接口,启动日志如下:

Mapped URL path [/v2/api-docs] onto method
[public org.springframework.http.ResponseEntity<springfox.documentation.spring.web.json.Json>
springfox.documentation.swagger2.web.Swagger2Controller.getDocumentation
(java.lang.String,javax.servlet.http.HttpServletRequest)]

 

8,在浏览器访问swagger页面,展示如下:


以上!


guolin

guolin

相信世界,向往美好,记录成长过程,分享个人心得,充实平凡生活。 网站信条:因为喜欢,所以热爱。

发表评论

电子邮件地址不会被公开。 必填项已用*标注