swagger学习

swagger 

Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。

简介

Swagger能成为最受欢迎的REST APIs文档生成工具之一，有以下几个原因：

• Swagger 可以生成一个具有互动性的API控制台，开发者可以用来快速学习和尝试API。
• Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。
• Swagger 文件可以在许多不同的平台上从代码注释中自动生成。
• Swagger 有一个强大的社区，里面有许多强悍的贡献者。

Petstore 的 Swagger 例子

swagger注释API详细说明

Swagger与RestFul 集成 以及 注解使用Demo

knife4j: https://doc.xiaominfo.com/

开源仓库

• Github

https://github.com/xiaoymin/swagger-bootstrap-ui

 

• 码云

https://gitee.com/xiaoym/knife4j

 

功能预览

• 在线预览

http://knife4j.xiaominfo.com/doc.html

老版本引用

<dependency> 
     <groupId>com.github.xiaoymin</groupId> 
     <artifactId>swagger-bootstrap-ui</artifactId> 
     <version>1.9.6</version>
</dependency>

新版本引用

<dependency> 
     <groupId>com.github.xiaoymin</groupId>
      <artifactId>knife4j-spring-ui</artifactId>
      <version>${lastVersion}</version>
</dependency>

• Spring Boot项目单体架构使用增强功能

 

在Spring Boot单体架构下,knife4j提供了starter供开发者快速使用

<dependency>
      <groupId>com.github.xiaoymin</groupId> 
     <artifactId>knife4j-spring-boot-starter</artifactId>
      <version>${knife4j.version}</version>
</dependency>

该包会引用所有的knife4j提供的资源，包括前端Ui的jar包

 

• Spring Cloud微服务架构

 

在Spring Cloud的微服务架构下,每个微服务其实并不需要引入前端的Ui资源,因此在每个微服务的Spring Boot项目下,引入knife4j提供的微服务starter

<dependency>
      <groupId>com.github.xiaoymin</groupId> 
     <artifactId>knife4j-micro-spring-boot-starter</artifactId>
      <version>${knife4j.version}</version>
</dependency>

在网关聚合文档服务下,可以再把前端的ui资源引入

<dependency>
       <groupId>com.github.xiaoymin</groupId> 
      <artifactId>knife4j-spring-boot-starter</artifactId> 
      <version>${knife4j.version}</version>
</dependency>