Swagger配置示例

Swagger与Postman不同，不支持在请求中传递Cookie

https://stackoverflow.com/questions/38984456/include-cookie-in-swagger-doc-requests

添加Swagger相关依赖，注意需要添加 springfox-swagger-ui才能访问Swagger Web页面

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.2.2.RELEASE</version><relativePath/> <!-- lookup parent from repository --></parent><groupId>com.sean</groupId><artifactId>swagger</artifactId><version>0.0.1-SNAPSHOT</version><name>swagger</name><description>Demo project for swagger</description><properties><java.version>1.8</java.version><spring-cloud.version>Hoxton.RELEASE</spring-cloud.version></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter</artifactId></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.18.10</version></dependency><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></dependencies><dependencyManagement><dependencies><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-dependencies</artifactId><version>${spring-cloud.version}</version><type>pom</type><scope>import</scope></dependency></dependencies></dependencyManagement><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins></build>
</project>

启动类设置开启Swagger

package com.sean;import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;@EnableSwagger2
@SpringBootApplication
public class SwaggerApplication {public static void main(String[] args) {SpringApplication.run(SwaggerApplication.class, args);}
}

Swagger相关配置

package com.sean.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.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;/*** Created by seanzou on 2019/12/10.*/
@Configuration
public class SwaggerConfig {@Beanpublic Docket controllerApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(new ApiInfoBuilder().title("swagger 2 测试").description("test").contact(new Contact("sean", null, null)).version("1.0.0").build()).select().apis(RequestHandlerSelectors.basePackage("com.sean")) // 接口检索包路径.paths(PathSelectors.any()) // 接口检索路径，支持any，none和regex.build();}
}

package com.sean;import com.sean.view.UserView;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;import javax.servlet.http.HttpServletRequest;/*** Created by seanzou on 2019/12/10.*/
@Api(value = "用户管理", tags = "用户管理")
@RestController
@RequestMapping(value = "/test")
public class TestController {@ApiOperation(value = "用户查询") // 用来描述方法@RequestMapping(value = "/user", method = RequestMethod.GET)public String getUser(HttpServletRequest request, @RequestParam(value = "uid")Long uid) {UserView view = new UserView();view.setUid(uid);view.setName("sean");view.setAge(99);return view.toString();}
}

package com.sean.view;import lombok.Data;/*** Created by seanzou on 2019/12/10.*/
@Data
public class UserView {private Long uid;private String name;private Integer age;
}

服务启动后，访问http://localhost:8080/swagger-ui.html即可进入Swagger Web页面

可以使用设置好的参数进行测试

Swagger配置示例相关推荐

hbase 默认目录_HBase 配置示例
基本分布式HBase安装在下文内容中是一个分布式10节点的群集的基本配置示例:其中,节点被命名为example0,example1...一直到example9,在这个例子中:HBase Master ...
Cisco Easy ***综合配置示例
以下内容摘自正在全面热销的最新网络设备图书"豪华四件套"之一<Cisco路由器配置与管理完全手册>(第二版)(其余三本分别是:<Cisco交换机配置与管理完全手册 ...
LVS DR模型配置示例
要让路由知道哪台主机是Director,进行选择: 1.VIP:MAC(Director VIP) -- MAC绑定,但未必可行,例如路由是运营商的. 2.arptables 3.kernel par ...
Logstash 参考指南（使用Filebeat Modules配置示例）
使用Filebeat Modules配置示例本节中的示例展示了如何构建用于解析Filebeat模块收集的数据的Logstash管道: Apache 2日志本例中的Logstash管道配置展示了如何 ...
Spring boot自动配置示例
自动配置示例 HttpEncodingAutoConfiguration Http编码自动配置以该类为例,查看自动配置过程 EnableAutoConfiguration HttpEncodingA ...
ASP.NET Core微服务(二)——【ASP.NET Core Swagger配置】
ASP.NET Core微服务(二)--[ASP.NET Core Swagger配置]: 环境:win10专业版+vs2019+sqlserver2014/2019 ASP.NET Core微服务( ...
Tomcat server.xml配置示例
转载自 Tomcat server.xml配置示例几乎所有容器类型的应用都会包含一个名为 server.xml 的文件结构.基本上,其中的每个元数据或者配置都是容器完成初始化所需要的.正是由于 ...
swagger生成示例_生成器设计模式示例
swagger生成示例本文是我们名为" Java设计模式 "的学院课程的一部分. 在本课程中,您将深入研究大量的设计模式,并了解如何在Java中实现和利用它们. 您将了解模式如此 ...
交华为换机access配置_华为交换机VLAN内Proxy ARP配置示例
华为交换机VLAN内Proxy ARP配置示例 1.组网需求图1 VLAN内Proxy ARP组网示例图如上图1所示,Switch的接口GE1/0/2和GE1/0/1属于同一个sub-VLAN2. ...

Swagger配置示例

Swagger配置示例相关推荐

最新文章

热门文章