springboot之RESTful接口与Swagger-编程知识

springboot之RESTful接口与Swagger

一、RESTful

GET获取资源、POST新建资源、PUT更新资源、DELETE删除资源。

RESTful两大特性

1、安全性：GET请求不会引起资源本身改变。

2、幂等性：对一个接口请求和多次请求返回的资源应该一致。

2xx：成功

4xx：客户端错误。

5xx：服务器错误。

URI中不要包含动词

通过使用PathVariable注解获取{id}

@GetMapping("/user/{id}")public String getUserById(@PathVariable int id){System.out.println(id);return "根据ID获取用户信息";}

二、Swagger

用于生成、描述、调用和可视化RESTful风格的Web服务。

配置方法

添加包。这里使用到的swagger2的版本是2.9.2记得把springboot的版本改成2.5.6！！！

<!-- swagger2相关功能       --><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version></dependency><!--  swagger2ui      --><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version></dependency>

创建SwaggerConfig.java文件，专门放在config包下。
在这里插入图片描述

把代码放进去就好了。
注意这里重写了addResourceHandlers方法

package com.example.hello.config;import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
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;//Spingboot中配置类必须要加注解
@Configuration
@EnableSwagger2
public class SwaggerConfig implements WebMvcConfigurer {@Overridepublic void addResourceHandlers(ResourceHandlerRegistry registry) {registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");}/** 配置swagger2相关Bean* */@Beanpublic Docket createRestApi(){return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com"))   //com包下所有API都交给Swagger2管理.paths(PathSelectors.any()).build();}/** 此处主要是API文档页面显示信息* */private ApiInfo apiInfo(){return new ApiInfoBuilder().title("演示项目API")   //标题.description("演示项目")    //描述.version("1.0").build();}}