Swagger 文档提供了一个方法,使我们可以用指定的 JSON 或者 YAML 摘要来描述你的 API,包括了比如 names、order 等 API 信息。
你可以通过一个文本编辑器来编辑 Swagger 文件,或者你也可以从你的代码注释中自动生成。各种工具都可以使用 Swagger 文件来生成互动的 API 文档。
注意:用 Swagger 文件生成互动的 API 文档是最精简的,它展示了资源、参数、请求、响应。但是它不会提供你的API如何工作的其他任何一个细节。
效果展示:
1.导入swagger-ui依赖
<!--swagger-ui-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
建立一个APIController
要对应的类上添加注解@Api(value = “商品名称”,tags = “商品信息相关API”,produces = MediaType.APPLICATION_JSON_VALUE),说明该API专用于商品信息,以json格式传递数据
@RestController=@RequestMapping+@Controller
package com.nf.psi.api;
import com.nf.psi.commons.Result;
import com.nf.psi.commons.ResultData;
import com.nf.psi.pojo.Goods;
import com.nf.psi.service.GoodsService;
import com.nf.psi.vo.GoodsReqVO;
import io.swagger.annotations.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.*;
import java.util.List;
/**
* @author Administrator
* @date 2019-04-11-09:29
*/
@Api(value = "商品名称"<