Swagger是用于生成、描述、调用和可视化RESTful风格的Web服务框架。它的总体目标是使客户端和文件系统作为服务器以同样的速度来更新,API始终保持同步。Swagger 使得管理和使用功能强大的API轻而易举。
工具/原料
1
IntelliJ IDEA编辑器
2
gradle管理的spring boot web项目
方法/步骤
1
1.首先在已有的项目中,打开build.gradle文件,添加下面Swagger需要的两个依赖包。
2
2. 编写一个SwiggerConfig类设置Swagger的相关信息,别忘啦在类声明处加上相应的注解。
3
3. Spring Boot自动配置本身不会自动把/swagger-ui.html这个路径映射到对应的目录META-INF/resources/下面。我们在WebMvcConfigurerAdapter类中加下这个映射即可。
5
5. 执行项目的启动类,将项目跑起来。当你看到Started xxx字样,则项目正常启动。
6
6. 启动之后,我们访问localhost:8080/swagger-ui.html这个地址即可查看到Swagger展现给我们的API接口文档。感觉很不错。
注意事项
这里所有的类应该在spring boot可扫描的范围内。
下一篇:弱电系统的控制措施