swagger导出接口文档

最近工作上需要用Swagger导出接口文档
经过查找资料总结了一下:

Swagger简介

1、是一款让你更好的书写API文档的规范且完整框架。
2、提供描述、生产、消费和可视化RESTful Web Service。
3、是由庞大工具集合支撑的形式化规范。这个集合涵盖了从终端用户接口、底层代码库到商业API管理的方方面面。
简单来说,Swagger是一个帮助开发人员编写接口文档的工具,它可以帮你自动生成接口文档。

Swagger使用

项目中使用Swagger有两种方法
1.**

使用第三方依赖

**

(1) pom.xml文件引入依赖:


com.spring4all
swagger-spring-boot-starter
1.7.0.RELEASE

(2)在Spring Boot项目的启动类上添加@EnableSwagger2注解,api方法中添加注解。

2.使用官方依赖

① pom.xml文件引入依赖:

io.springfox springfox-swagger2 2.7.0 io.springfox springfox-swagger-ui 2.7.0

② 编写Swagger控制类

注意:swagger scan base package,这是扫描注解的配置,即你的API接口位置。需要修改为实际项目的Api位置
③ 在Spring Boot

你可能感兴趣的:(java,Swagger,java,接口文档,api)