RESTful风格接口+Swagger生成Web API文档

RESTful风格接口+Swagger生成Web API文档

1.RESTful风格接口

RESTful简介

也就是说，RESTful是一种接口标准

RESTful详细图示

常见http状态码

springboot实现RESTful

RESTful springboot设计实例

demo

package com.example.demo.controller;import com.example.demo.mapper.User;
import org.springframework.web.bind.annotation.*;@RestController
public class UserController {@GetMapping("/user/{id}")public String getUserById(@PathVariable int id) {return "根据ID获取用户";}@PostMapping("/user")public String save(User user) {return "添加用户";}@PutMapping("/user")public String update(User user) {return "更新用户";}@DeleteMapping("/user/{id}")public String deleteById(@PathVariable int id) {return "根据ID删除用户";}
}

2.Swagger生产Web API文档

Swagger简介

使用Swagger

1.加入依赖

<!-- Swagger 2.x 依赖 --><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version></dependency>

2.配置Swagger

package com.example.demo.config;import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;@Configuration // 告诉Spring容器，这个类是一个配置类
@EnableSwagger2 // 启用Swagger2功能
public class Swagger2Config {@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()) // 这里缺少了方法调用的括号.select() // 构建API选择器.apis(RequestHandlerSelectors.basePackage("com")) // com包下所有API都交给Swagger2管理.paths(PathSelectors.any()) // 选择所有的路径.build();}// API文档页面显示信息private ApiInfo apiInfo() {return new ApiInfoBuilder().title("演示项目API") // 标题.description("学习Swagger2的演示项目") // 描述.build();}
}