草庐IT

swagger-codegen

全部标签

java - 如何在 spring boot rest 应用程序中使用 Swagger ui 配置带有密码流的 oAuth2

我有springbootrestapi(资源),它使用另一个springboot授权服务器,我已将Swagger配置添加到资源应用程序中,以便为restAPI获得一个快速的文档/测试平台。我的Swagger配置如下所示:@Configuration@EnableSwagger2publicclassSwaggerConfig{@AutowiredprivateTypeResolvertypeResolver;@Value("${app.client.id}")privateStringclientId;@Value("${app.client.secret}")privateStrin

java - 使用 swagger UI 记录包装的 REST 响应

我有一个WidgetDto,我已经用swaggerUI注释进行了注释。最终响应用一层元数据包装WidgetDto列表(每页21ofthisRESTful最佳实践文档)。例如:{"data":[{"id":1234,"prop1":"val1"...},{"id":5678,"prop1":"val2"...},...]}我的java代码如下所示:@GET@Produces(MediaType.APPLICATION_JSON)@ApiOperation(value="Getallwidgets.",response=WidgetDto.class)@ApiResponses(value

.NET Core WebAPI项目部署iis后Swagger 404问题解决

.NETCoreWebAPI项目部署iis后Swagger404问题解决前言之前做了一个WebAPI的项目,我在文章中写到的是Docker方式部署,然后考虑到很多初学者用的是iis,下面讲解下iis如何部署WebAPI项目。环境准备iisASPNETCoreModuleV2重点.NETCoreRuntimeiis的配置这里就不讲了,主要讲解.NETCore项目部署之后Swagger无法访问问题。ASPNETCoreModuleV2安装:https://dotnet.microsoft.com/en-us/download/dotnet/6.0修改配置文件修改Program.cs配置文件将if(

如何在IDE部署springboot项目(有swagger和无swagger都是一样的)到服务器或者虚拟机上的docker

目录一、前言二、现在开始分享一下安装历程:一、前言最近写了个项目,前端还没写,需要部署到服务器给女朋友实现前端,可是不熟悉Linux的我,蹑手蹑脚,真的是每一步都是bug,可谓是步步维艰,对世界很绝望,曾经怀疑自己的服务器有问题,甚至一度怀疑是自己的DaoBanIDE有问题,历时两天一夜,终于……部署好了。二、现在开始分享一下安装历程:1.购买一个服务器或者安装虚拟机(有点像废话)2.安装docker(可以使用yum安装)tips:安装好docker之后需要配置一下,输入下面这行代码,进入docker配置文件,在ExecStart=后添加配置,远程访问docker的端口为2375sos:如果是

java - CXF codegen maven 插件不工作 OpenJDK 11

我一直在使用JDK9和10以及CXFcodegen插件3.2.5和3.2.6,没有任何问题,但是今天我正在尝试将我的代码库从OracleJDK10更新到OpenJDK11build28,但是我'我总是得到同样的错误:[INFO]Erroroccurredduringinitializationofbootlayer[INFO]java.lang.module.FindException:Modulejava.xml.wsnotfound[INFO]----------------------------------------------------------------------

java - 使用 swagger 或任何其他工具生成 Rest API 文档

我正在寻找一种方法来记录我的RestAPI。我的服务器是Tomcat/Spring服务器,RestAPI是使用Jenkins实现的。Swagger似乎是一个非常酷的解决方案,但我不知道如何将它用于我的代码。我正在寻找创建jsonswagger-ui可以读取的最佳方法-我应该怎么做?此外,我很乐意检查在此类环境中记录RestAPI的任何其他好的解决方案。 最佳答案 我没试过swagger但你可以试试enunciate.它可以生成JAX-RS端点的文档作为javadoc阶段的一部分。enunciatepage上提供了生成文档的一些示例更

java - 在 swagger UI 试用中发送动态自定义 header

我在java中使用swagger。我正在通过代码中的requestAttributes读取一个名为callerId的header。我没有通过注释@HeaderParam使用header。由于这个原因,header部分不会显示在用于试用的swaggerUI中。如何让这个标题显示在试用表单中。有什么方法可以在不对header值进行硬编码的情况下实现这一目标。提前致谢。 最佳答案 您可以使用@ApiImplicitParams和@ApiImplicitParam向操作添加参数。以下wiki文档应该为您提供有关如何使用这些注释的解释-htt

java - SpringFox Swagger - 模型中的可选和必填字段

我将SpringFox库用于我的springboot应用程序的其余文档。当我点击model时,所有元素都作为可选元素返回。有没有办法将必需的元素显示为强制性的?是否需要添加任何其他配置? 最佳答案 默认是的所有字段都是可选的。要根据需要标记字段,您可以使用以下注释。@ApiModelProperty(required=true)关于应该需要的字段的getter方法。这不会将该字段显示为“必填”。但文档中此字段的可选标记将被删除。希望这对您有所帮助。 关于java-SpringFoxSwa

java - 如何手动记录 JAX-RS 参数的 Swagger 数据模型?

上下文假设我有一个简单的Java数据类:publicclassPerson{privatefinalStringname;privatefinalintage;Person(Stringname,intage){this.name=name;this.age=age;}publicStringgetName(){returnname;}intStringgetAge(){returnage;}}注意:在实践中,我使用Immutables生成这个,但我正在显示POJO这里是为了简单起见。为了记录GET响应的模型,即使返回类型是Response,我也可以引用@ApiOperation中的类

java - Swagger 处理多个基本路径

我正在使用swagger-ui为我们的客户提供RESTAPI的良好文档。在内部,我们有两个不同的环境jenkin将项目构建到。例如。swagger.json在两种环境中都可以访问:http://www.myhost.com/xyz/rest/swagger.jsonhttps://www.myhost2.com/rest/swagger.json文档可作为:http://www.myhost.com/xyz/dist/index.htmlhttps://www.myhost2.com/dist/index.htmlweb.xml中的swaggerapibasepath是:swagger