JAVA工程使用swagger,很方便,配置也简单。
简单介绍Swagger官网的使用:
进入Swagger官网(现在是2.0版本)主要看SPECIFICATION,TOOLS和DOCS。
- SPECIFICATION:主要介绍Swagger接口的规范问题,Swagger实际上是一个RESTful接口的API
- TOOLS:Swagger的TOOLS包含Swagger Editor(开源的编辑器,可以设计,描述和记录API),Swagger Codegen(Swagger的代码生成工具),Swagger UI(API的页面)
- DOCS:Swagger的帮助文档
下载Swagger官网例子
Swagger接口支持各种语言,它的自动生成工具,既可以生成客户端的代码,也可以生成服务器端代码
进入Swagger Editor页面,点击ONLINE EDITOR,进入editor页面,可以选择生成客户端还是服务端代码,我们现在以生成服务端的JAVA项目为例,选择spring
即可下载。
例子的说明
下载例子后,导入到项目中
项目结构
配置文件中配置扫描的api与controller路径
api是接口,controller是接口的实现。
在Swagger2SpringBoot类启动项目,默认在application.properties文件中contextPath是v2,所以访问路径是
http://localhost/v2:8080
界面如下则成功启动: