swagger使用注意的问题:
1,下载的ui和依赖的jar要配套
2,swagger中index.html配置的地址就是访问接口的地址http://localhost:8081/hb_phonebank_web/v2/api-docs /api-docs这个结尾(webapp下)
3,只针对 @ResponseBody返回json数据的接口, @RequestMapping(value = { "/update" }, method = RequestMethod.POST,produces="application/json;charset=UTF-8")
POST需要参数
GET方法中不能加参数(可以用模型驱动)
- 在GET请求中,不能使用@RequestBody。
- 在POST请求,可以使用@RequestBody和@RequestParam,但是如果使用@RequestBody,对于参数转化的配置必须统一
@RequestMapping(value = { "/newApply" }, method = RequestMethod.GET)
public String prepareNewApplyData(/*@RequestParam String orgId,@RequestParam String loanTermCode,@RequestParam String purposeCode,*/ModelMap map) {
}
@ResponseBody
@RequestMapping(value = { "/initCustomer" }, method = RequestMethod.GET)
public String initCustomer(InitCustomerParameter params){
}
@ResponseBody
@RequestMapping(value = { "/update" }, method = RequestMethod.POST,produces="application/json;charset=UTF-8")
@ApiResponses(value = {@ApiResponse(code = 200, message = "商品信息", response=String.class),
@ApiResponse(code = 201, message = "q"+ "(token验证失败)", response=String.class),
@ApiResponse(code = 202, message = "500" + "(系统错误)",response = String.class)})
@ApiOperation(value="查询列表",notes="/update",response = String.class)
public String update(@RequestBody(required = false) FinancialSalesUser financialSalesUser) throws Exception{}
@ResponseBody
@RequestMapping(value = { "/list" }, method = RequestMethod.GET,produces="application/json;charset=UTF-8")
@ApiResponses(value = {@ApiResponse(code = 200, message = "商品信息", response=String.class),
@ApiResponse(code = 201, message = "q"+ "(token验证失败)", response=String.class),
@ApiResponse(code = 202, message = "500" + "(系统错误)",response = String.class)})
@ApiOperation(value="查询列表",notes="/list",response = String.class)
public String getweixinBaseInfoList() {}
4,
@requestbody
时间不可传:
虽然名称可以一样,但是类型匹配不了springmvc也接受不了(测试数据)
示例:
pom.xml
<!--swagger -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
</dependency>
spring.xml
用一个单独的swagger文件放下载下的ui
<mvc:resources mapping="/swagger/**" location="/swagger/"/>
<mvc:annotation-driven/>
<bean class="com.houbank.incoming.web.controller.MySwaggerConfig" />
配置java:
package com.houbank.incoming.web.controller;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class MySwaggerConfig {
}
应用;
@Controller
@Slf4j
@RequestMapping({ "/financialSalesUser" })
@Api(value="/financialSalesUser",description="测试信息")
public class FinancialSalesUserController {
@Reference
private FinancialSalesUserFacade financialSalesUserFacade;
@ResponseBody
@RequestMapping(value = { "/list" }, method = RequestMethod.GET,produces="application/json;charset=UTF-8")
@ApiResponses(value = {@ApiResponse(code = 200, message = "商品信息", response=String.class),
@ApiResponse(code = 201, message = "q"+ "(token验证失败)", response=String.class),
@ApiResponse(code = 202, message = "500" + "(系统错误)",response = String.class)})
@ApiOperation(value="查询列表",notes="/list",response = String.class)
public String getweixinBaseInfoList() {
String q="";
try {
// CoreBusinessType condition = new CoreBusinessType();
// condition.setTypeName("车抵贷");
FinancialSalesUserCondition financialSalesUserCondition =new FinancialSalesUserCondition();
BaseResponse<List<FinancialSalesUser>> baseResponse = financialSalesUserFacade.selectAll(financialSalesUserCondition);
if (baseResponse != null && CollectionUtils.isNotEmpty(baseResponse.getData())) {
q= JSON.json(baseResponse.getData());
log.info(JSON.json(baseResponse.getData()));
// modelMap.put("coreTypeList", baseResponse.getData());
}
} catch (Exception e) {
log.error("错误"+e);
}
return q;
}
//@RequestBody FinancialSalesUser financialSalesUser
@ResponseBody
@RequestMapping(value = { "/insert" }, method = RequestMethod.POST,produces="application/json;charset=UTF-8")
@ApiResponses(value = {@ApiResponse(code = 200, message = "商品信息", response=String.class),
@ApiResponse(code = 201, message = "q"+ "(token验证失败)", response=String.class),
@ApiResponse(code = 202, message = "500" + "(系统错误)",response = String.class)})
@ApiOperation(value="查询列表",notes="/insert",response = String.class)
public String insert(@RequestBody(required = false) FinancialSalesUser financialSalesUser) throws Exception{
String q="";
try {
// CoreBusinessType condition = new CoreBusinessType();
// condition.setTypeName("车抵贷");
// FinancialSalesUser financialSalesUser =new FinancialSalesUser();
if(financialSalesUser==null){
financialSalesUser =new FinancialSalesUser();
financialSalesUser.setPassWord("222");
financialSalesUser.setStatus("2");
financialSalesUser.setCreatedTime(new Date());
financialSalesUser.setUserName("222");
}
q = financialSalesUserFacade.insert(financialSalesUser)+"";
} catch (Exception e) {
log.error("错误"+e);
}
return q;
}
}
访问:
http://localhost:8081/hb_phonebank_web/swagger/index.html
输入:http://localhost:8081/hb_phonebank_web/v2/api-docs
相关推荐
Swagger 解析器 注意:如果您正在寻找 swagger-parser 1.X 和 OpenAPI 2.0,请参阅 v1 分支 注意:从 2.1.0 版开始,Swagger Parser 支持 OpenAPI 3.1;详情请参阅此页面
前言:我注意到,只要提供了合适的 swagger.json,swagger ui 就会帮我们完成其他的:动态生成 web 客户端,让我们可以在线浏览 API,构建/发送请求并获得响应。所以,在发现现有框架都不能支持在 request/...
swagger4spring-web, 对 Spring MVC的Swagger支持 swagger4spring-web请注意:这里项目不再主动支持。支持 Swagger 1.3,版本 0.3.0 !这个项目旨在为基于spring的应用提供Swagger支持。 它将尝试基于现有的spring...
使用自动进行RESTful API测试 注意:该项目正在开发中,尚未准备就绪。 安装 npm install swagger-testing 用法 独立的 var SwaggerTesting = require ( 'swagger-testing' ) ; var swaggerSpec = require ( './...
注意:如果您正在寻找swagger core 1.5.x和openapi 2.0,请参考1.5分支。
注意:如果您正在寻找swagger-parser 1.X和OpenAPI 2.0,请参考 目录 总览 这是Swagger Parser项目,该项目将JSON或YAML格式的OpenAPI定义解析为表示形式,返回任何验证警告/错误。 它还提供了一个简单的框架,...
.netcore3.1添加swagger及JWT Authorize 验证 JWT 的优缺点 相比于传统的 cookie-session 认证机制,优点有: 更适用分布式和水平扩展 在cookie-session方案中,cookie内仅包含一个session标识符,而诸如用户...
转换为asciidoc,继而转换成其他各种格式,如:HTML、PDF、EPUB3、DOCBOOK等主要用到了两个maven插件:swagger2markup-maven-pluginasciidoctor-maven-plugin如何使用将swagger.yaml或swagger.json文件放入src/test/...
注意是 mac 版的,说明:https://blog.csdn.net/wide288/article/details/114845716
注意:仅支持规范的Swagger 2.0版。 安装 您可以将gem安装为 gem install ruby-swagger 或将其添加到您的捆绑包中: gem 'ruby-swagger' 然后 bundle install 如果在Grape项目中使用ruby-swagger,请确保在gemfile...
如果您当前正在使用@nestjs/swagger@3.* ,请注意4.0版中的以下@nestjs/swagger@3.* / API更改。 以下装饰器已更改/重命名: @ApiModelProperty现在是@ApiProperty @ApiModelPropertyOptional现在为@...
前台项目、后台项目、以及数据库都有,如果环境没问题,下载下去应该可以直接使用。 自己在学习的过程中搭建的,有缺陷欢迎大家指出来。前台写的有点乱,毕竟不是专业的。 后台使用的idea开发的。前台使用的vscode。
这是将React与Redux结合使用的一种模式,该脚本使用TypeScript中的Swagger Codegen API客户端来构建应用程序。 这是基于我构建。 请首先参考该模式以了解该方法。 对于API示例,我们使用 API,其中包括Swagger API...
一个基于角色的访问控制器并使用swagger(现在命名为OpenAPI) 在YAML文件中,将x-resource选项添加到每个路径。 当用户访问该URL时,中间件将根据资源名称和HTTP方法检查权限。 像“用户test-user有权限post资源的...
spring版本要注意要跟我的差不多不然jar包会有些冲突没分数下载的留邮箱或者到我博客的文章里面留言,我会不定时地上来看看
它将创建文件petstore_example/swagger.puml ,然后可以使用PlantUML将其转换为PNG图像,并具有以下内容: plantuml petstore_example/swagger.puml -tpng 请注意,您需要为此安装和 。 安装 该脚本与Python 3一起...
球衣演示Jersey-Swagger集成您需要完成四个步骤,才能使用Swagger设置球衣应用程序: 创建基于Maven的Jersey2.0 Java EE Web应用程序mvn原型:generate -DarchetypeArtifactId = jersey-quickstart-webapp -...
小工具一枚,欢迎使用和Star支持,如使用过程中碰到问题,可以提出问题,我会尽力完善该Starter 版本基础 摇摇欲坠:2.9.2 如何使用 在该项目的帮助下,我们的Spring Boot可以轻松的约会sswagger2,主需要做下面两个...
注意:该项目已不再积极维护。 自2019年以来,我们的开发重点已移至 ,而维护这两个项目的Cyclos项目早已移至OpenAPI3。因此,对ng-swagger-gen的维护基本上是由社区通过拉取请求。 但是,由于ng-swagger-gen没有...
//注意:在IIS部署时如果不定义该自定义管道中间件“http://localhost:8090”页面会出现“404”错误,但“http://localhost:8090/Swagger/index.html”页面可用; //如果定义该自定义管道中间件IIS部署后的...