swagger

1热度

1回答

我正在定义一个API，并且我有一个名为“有效内容”的字段。我们有这个字段定义为 “类型”：字符串我们招摇但是开始的有效载荷数据有结构。更特别的是，客户端发送json对象作为必须遵守某些规则的有效载荷数据。例如有效载荷可以是： { "bark": true, "breed": "Dingo" } 如果有效载荷是一个Dog对象或 { "hunts": true,

0热度

1回答

数组中招摇API文档

我想在这样的招摇API-doc的数组引用一个对象（有更多的对象，但在相同的模式）使用参考得到这个错误： error TS2345: Argument of type '{ paths: { path: string; module: any; }[]; app: any; apiDoc: { 'x-express-openapi-additional-midd...' is not assigna

1热度

1回答

验证OpenAPI是否符合REST设计最佳实践

我们正在使用Swagger从源代码生成API文档。我现在想知道是否有任何工具会自动检查生成的OpenAPI文档（= Swagger JSON）与RESTful API设计最佳实践的符合性。例如Zalando已经在这些准则所定义的REST设计一个公开的指导方针在我看来有可自动检查基础上，OpenAPI的规格很多规则： “不要向后打破兼容性“可以在不同版本的OpenAPI 文件进行比较时进行检查。

0热度

1回答

swagger-play2无法在子项目中找到它的ApiHelpController包路径

我正在尝试将swagger添加到我的一个子项目中。我已经加入了 “ApiHelpController”，如下子项目路线文件 GET /swagger.json controllers.ApiHelpController.getResources 子项目的conf文件 play.modules.enabled += "play.modules.swagger.SwaggerModule"

-3热度

1回答

如何导入扬鞭配置

背景我遇到了一些扬鞭配置的问题，所以我想通过复制一些简单的例子的CONFIGS解决这些问题。我阅读本教程： http://www.baeldung.com/swagger-2-documentation-for-spring-rest-api 而且他们有这样的： @Configuration @EnableSwagger2 public class SwaggerConfig {

2热度

2回答

Swashbuckle：请非空的属性需要

在ASP.NET Web应用程序的核心使用Swashbuckle.AspNetCore，我们有响应类型，如： public class DateRange { [JsonConverter(typeof(IsoDateConverter))] public DateTime StartDate {get; set;} [JsonConverter(typeof(I

4热度

1回答

如何在swagger propertise中添加多个示例值？

我使用扬鞭OpenAPI的规格工具，我有一个字符串数组属性中的定义之一如下： cities: type: array items: type: string example: "Pune" 我的API产生JSON结果因此对于下面的结果上述对象出现在响应： { "cities": [ "Pune" ] } 试

1热度

1回答

使用外部定义中扬鞭/ Zircote/Nelmio-API文档

我使用以下版本： zircote/swagger-php in version 2.0.10 nelmio/api-doc-bundle in version v3.0.0-BETA4 一举 /** * @Operation( * tags={"DeliverySlip"}, * summary="Send information after delivery

3热度

1回答

如何在Swagger中使用Swagger注释设置描述和示例？

我正在使用Spring引导创建一个REST Api，并使用swagger codegen自动生成控制器中的swagger文档。但是，我无法为POST请求中的String类型参数设置说明和示例。下面是MI代码： import io.swagger.annotations.*; @Api(value = "transaction", tags = {"transaction"}) @Functi

1热度

1回答

Swagger - 声明异常的渲染响应状态

我正在使用Swagger来处理我的REST文档。我已经设置好了，并且可以在SwaggerUi上访问，并且还可以看到我配置的所有REST资源及其受支持的方法。在我的后端我有一个ControllerAdvice，它为我的所有控制器执行全局异常处理。当我尝试创建一个已经存在的资源时，在控制器建议中处理的示例异常是ResourceAlreadyExistsException。在这种情况下，我的异常处理程