swagger api 之（一）

最新推荐文章于 2024-07-26 09:36:54 发布

脾气很倔呢

最新推荐文章于 2024-07-26 09:36:54 发布

阅读量5k

点赞数

分类专栏： spring-boot swagger 文章标签： spring-boot

本文链接：https://blog.csdn.net/expect521/article/details/77507192

版权

本文档介绍了如何使用Spring Boot、Swagger构建一个包含用户增删改查操作的RESTful API，并生成对应的API文档。通过Swagger注解详细解释了如何定义URL路径、处理HTTP请求方法以及返回JSON响应。提供了代码片段和访问URL以供参考。

摘要由CSDN通过智能技术生成

功能

生成一个swagger api文档，内容是对用户增删改查的操作，返回数据格式是json。用的是restful风格。例如：

这里写图片描述

技术与IDE

spring boot
IntelliJ IDEA
maven
swagger

代码参考github：

Swagger-Restful-Api

代码片段

UserService.java

@RestController
@RequestMapping(value = "/user")
public class UserService {
   

    @Autowired
    private UserReponsitory userReponsitory;

    /**
     * @Function get all users(getUsers())
     * @Get
     * @url ""
     * @param no
     * @return List<User></>
     */
    @ApiOperation(value = "获取用户列表",notes = "获取所有的用户的详细信息")
    @RequestMapping(value = "/users",method = RequestMethod.GET)