Spring+Swagger文档无法排序问题解决

项目中用到swagger用于自动生成文档,遇到了好多结合后的问题。而对于这个排序问题,在查看了后端Swagger原代码之后,发现视乎当前使用的swagger(不是springfox,应该不是官方的,网上好多教程是spring结合swagger,直接拿来用了)虽然有排序的Reader但是都没有实现文档的排序。

要实现排序可以从SwaggerUi入手。在:

      window.swaggerUi = new SwaggerUi({
          ...
      });

上面代码中,我们添加排序属性:

window.swaggerUi = new SwaggerUi({  

...  

apisSorter: "alpha", // can also be a function
operationsSorter : "method" // can also be ‘alpha‘ or a function
});

于是就能实现文档排序了,当然这个好像是说swagger2.0之后才有这两个属性。

时间: 2024-10-28 16:08:07

Spring+Swagger文档无法排序问题解决的相关文章

如何Spring Cloud Zuul作为网关的分布式系统中整合Swagger文档在同一个页面上

本文不涉及技术,只是单纯的一个小技巧. 阅读本文前,你需要对spring-cloud-zuul.spring-cloud-eureka.以及swagger的配置和使用有所了解. 如果你的系统也是用zuul作为分布式系统的网关,同时使用swagger生成文档,想把整个系统的文档整合在同一个页面上,可以参考本文. 项目结构eureka-server:eureka服务注册中心,端口8080, zuul-server:zuul网关,端口8081 payment-server:支付系统,端口8082 or

Swagger文档转Word 文档

GitHub 地址:https://github.com/JMCuixy/SwaggerToWord/tree/developer 原创作品,转载请注明出处:http://www.cnblogs.com/jmcui/p/8298823.html 一.前言 为什么会产生这个需求呢? 我们公司作为乙方,老是被客户追着要一份API文档,当我们把一个 Swagger 文档地址丢给客户的时候.客户还是很不满意,嫌不够正式!!死活坚持要一份 word 文档 .然后领导给了个接口模板,就把这个活交给我了...

spring接口文档注解:@ApiOperation(转)

spring接口文档注解:@ApiOperation @ApiOperation不是spring自带的注解是swagger里的 com.wordnik.swagger.annotations.ApiOperation; @ApiOperation和@ApiParam为添加的API相关注解,个参数说明如下: @ApiOperation(value = "接口说明", httpMethod = "接口请求方式", response = "接口返回参数类型&qu

swagger文档分组显示

公司的项目,很多子模块是可以独自启动的spring boot服务,但是又搞了一个总的spring boot项目把其他子模块依赖进来,然后启动整体的服务,但是有xx同学反馈说swagger文档只能看见第一个子项目的. 经研究,配置swagger的时候,Docket 创建的时候没有指定名称,bean名称相同的被覆盖了,给bean指定特定的名称,然后给docket配置一个groupName,就可以解决了. 这样就可以是多个子模块的文档同时存在并按groupName分组,在右上角下拉菜单里就可以选择了.

【Swagger2】解决swagger文档地址请求404的问题

一.出现的问题背景 某个项目,本地启动后,访问swagger文档地址可以访问到, http://localhost:8203/doc.html.但是部署到开发环境就访问不到,报404资源找不到的问题 二.如何解决 开发环境的配置和本地配置不一致.将开发环境如下配置去掉就OK了或者设置为true(启用默认资源处理) spring.resources.add-mappings: false 原文地址:https://www.cnblogs.com/756623607-zhang/p/11287032

swagger文档原来就这样搞定出来

根据大神博客与书轻松搭建自己的swagger文档太厉害了 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox<

SpringBoot系列五:集成Swagger文档

本篇开始介绍Api文档Swagger的集成 一.引入maven依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfo

使用 Swagger 文档化和定义 RESTful API

大部分 Web 应用程序都支持 RESTful API,但不同于 SOAP API——REST API 依赖于 HTTP 方法,缺少与 Web 服务描述语言(Web Services Description Language,WSDL)类似的语言来定义使用者与提供者之间的请求和响应结构.由于没有充分的合同服务,许多 REST API 提供者使用 Microsoft Word 文档或维基页面来记录 API 用法.这些格式使协作和文档版本控制变得很困难,尤其对于有许多 API 或资源的应用程序,或者

swagger文档添加jwt认证

最近写的swagger文档,要加jwt授权,所以几经google终于搞定了,简简单单几行配置如下: securityDefinitions: APIKey: type: apiKey name: Authorization in: header security: - APIKey: []