I. Introducción
Swagger-ui es un complemento para producir documentación API en el desarrollo de Java, que es un puente para las interfaces de depuración conjunta entre ingenieros de back-end y ingenieros de front-end. Los documentos generados reducen mucha comunicación innecesaria y mejoran la eficiencia del desarrollo y las pruebas.
Segundo, el uso de swagger-ui
1. Introducir la dependencia de Maven
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${swagger2.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${swagger2.version}</version>
</dependency>
Actualizar: <swagger2.version>2.9.2</swagger2.version>
2. Agregue anotaciones a la clase de inicio Springboot.
@EnableSwagger2
Indica que el documento está abierto.
3. Agregue la anotación @ApiOperation al método del controlador.
como:
@RestController
@RequestMapping("tmpMUser")
public class TmpMUserController {
@Autowired
private TmpMUserService tmpMUserService;
@ApiOperation(value = "解密酒店手机号", httpMethod = "POST", response = ResponseData.class, notes = "解密酒店手机号")
@PostMapping("updateOne")
public ResponseData<String> updateOne(Map<String, Object> param) {
try {
tmpMUserService.updateOne();
return ResponseData.success("成功");
} catch (Exception e) {
e.printStackTrace();
}
return ResponseData.error();
}
}4. Acceda a través de la ip del proyecto más el puerto más swagger-ui.html#
http://ip:puerto/swagger-ui.html#
5. Descripción del documento
El documento presenta el método de solicitud, la dirección y el propósito de la interfaz.
3. Anotaciones más ricas
Además del uso simple anterior, la API tiene muchas anotaciones enriquecidas.
/**
@Api：修饰整个类，描述Controller的作用
@ApiOperation：描述一个类的一个方法，或者说一个接口
@ApiParam：单个参数描述
@ApiModel：用对象来接收参数
@ApiProperty：用对象接收参数时，描述对象的一个字段
@ApiResponse：HTTP响应其中1个描述
@ApiResponses：HTTP响应整体描述
@ApiIgnore：使用该注解忽略这个API
@ApiError ：发生错误返回的信息
@ApiImplicitParam：一个请求参数
@ApiImplicitParams：多个请求参数
*/
Por ejemplo:
@ResponseBody
@PostMapping(value="/login")
@ApiOperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
public UserModel login(@ApiParam(name = "name", value = "用户名", required = false)
@RequestParam(value = "name", required = false)
String account,
@ApiParam(name = "pass", value = "密码", required = false)
@RequestParam(value = "pass", required = false)
String password){}
//或以实体类为参数：
@ResponseBody
@PostMapping(value="/login")
@ApiOperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
public UserModel login(@ApiParam(name = "model", value = "用户信息Model") UserModel model){}
4. Introducción a swagger-ui
OpenAPI es una especificación para escribir documentos API, pero escribir manualmente documentos de especificación OpenAPI es muy problemático. Swagger es un conjunto de herramientas que implementa la especificación OpenAPI.
Simplifique el desarrollo de API para usuarios, equipos y empresas con el conjunto de herramientas profesionales y de código abierto de Swagger. Descubra cómo Swagger puede ayudarle a diseñar y documentar sus API a escala.