swagger-api/swagger-ui

Swagger UI 提供了三个不同的 NPM 模块,适用于不同场景:swagger-ui 适用于单页应用,swagger-ui-dist 适用于服务器端项目或无法解决 npm 依赖的单页应用,而 swagger-ui-react 则是作为 React 应用的组件。建议单页应用使用 swagger-ui,因为其体积更小。此外,Swagger UI 兼容 OpenAPI 规范的多个版本,包括 2.0 和 3.0。
部署运行你感兴趣的模型镜像

This repository publishes three different NPM modules:

swagger-ui is a traditional npm module intended for use in single-page applications that are capable of resolving dependencies (via Webpack, Browserify, etc).
swagger-ui-dist is a dependency-free module that includes everything you need to serve Swagger UI in a server-side project, or a single-page application that can’t resolve npm module dependencies.
swagger-ui-react is Swagger UI packaged as a React component for use in React applications.
We strongly suggest that you use swagger-ui instead of swagger-ui-dist if you’re building a single-page application, since swagger-ui-dist is significantly larger.

Compatibility
The OpenAPI Specification has undergone 5 revisions since initial creation in 2010. Compatibility between Swagger UI and the OpenAPI Specification is as follows:

Swagger UI Version Release Date OpenAPI Spec compatibility Notes
3.18.3 2018-08-03 2.0, 3.0 tag v3.18.3
3.0.21 2017-07-26 2.0 tag v3.0.21
2.2.10 2017-01-04 1.1, 1.2, 2.0 tag v2.2.10
2.1.5 2016-07-20 1.1, 1.2, 2.0 tag v2.1.5
2.0.24 2014-09-12 1.1, 1.2 tag v2.0.24
1.0.13 2013-03-08 1.1, 1.2 tag v1.0.13
1.0.1 2011-10-11 1.0, 1.1 tag v1.0.1
Documentation
Usage
Installation
Configuration
CORS
OAuth2
Deep Linking
Limitations
Version detection
Customization
Overview
Plugin API
Custom layout
Development
Setting up
Scripts
Integration Tests
You will need JDK of version 7 or higher as instructed here https://nightwatchjs.org/gettingstarted/#selenium-server-setup

Integration tests can be run locally with npm run e2e - be sure you aren’t running a dev server when testing!

Browser support
Swagger UI works in the latest versions of Chrome, Safari, Firefox, and Edge.

Known Issues
To help with the migration, here are the currently known issues with 3.X. This list will update regularly, and will not include features that were not implemented in previous versions.

Only part of the parameters previously supported are available.
The JSON Form Editor is not implemented.
Support for collectionFormat is partial.
l10n (translations) is not implemented.
Relative path support for external files is not implemented.
Security contact
Please disclose any security-related issues or vulnerabilities by emailing security@swagger.io, instead of using the public issue tracker.

您可能感兴趣的与本文相关的镜像

Stable-Diffusion-3.5

Stable-Diffusion-3.5

图片生成
Stable-Diffusion

Stable Diffusion 3.5 (SD 3.5) 是由 Stability AI 推出的新一代文本到图像生成模型,相比 3.0 版本,它提升了图像质量、运行速度和硬件效率

要访问或配置 Swagger UI 的 `index.html` 页面,首先需要确认是否正确配置了相关的依赖和访问路径。 ### 访问 Swagger UI 页面 在 Spring Boot 项目中,通常通过以下路径访问 Swagger UI 的首页: ``` http://localhost:<port>/swagger-ui/index.html ``` 其中 `<port>` 是项目的运行端口,例如 `9082`。如果使用的是 Swagger 2.x 版本,则路径为: ``` http://localhost:<port>/swagger-ui.html ``` 如果访问时页面显示空白,可以检查依赖是否正确,以及是否与其他配置冲突[^2]。 ### 配置自定义的 index.html 如果需要自定义 Swagger UI 的首页内容,可以将自定义的 `index.html` 文件放置在以下路径之一: - `src/main/resources/static/swagger-ui/` - `src/main/resources/public/swagger-ui/` 确保自定义的 `index.html` 文件不会覆盖默认的 Swagger UI 文件,除非确实需要修改默认行为。如果需要完全替换默认页面,可以参考以下代码示例: ```html <!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>Custom Swagger UI</title> <link rel="stylesheet" type="text/css" href="/webjars/swagger-ui/swagger-ui.css"> </head> <body> <div id="swagger-ui"></div> <script src="/webjars/swagger-ui/swagger-ui-bundle.js"></script> <script> window.onload = function () { const ui = SwaggerUIBundle({ url: "/v2/api-docs", dom_id: '#swagger-ui', presets: [ SwaggerUIBundle.presets.apis, SwaggerUIBundle.SwaggerUIStandalonePreset ], layout: "StandaloneLayout" }); }; </script> </body> </html> ``` ### 依赖配置 确保项目中已正确引入 Swagger 的相关依赖。以下是一个常见的依赖配置示例: ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>3.0.0</version> <exclusions> <exclusion> <groupId>io.swagger</groupId> <artifactId>swagger-models</artifactId> </exclusion> </exclusions> </dependency> <dependency> <groupId>io.swagger</groupId> <artifactId>swagger-models</artifactId> <version>1.5.22</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>3.0.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> ``` ### 配置类 为了启用 Swagger,还需要在配置类中启用 Swagger 并配置相关参数: ```java 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.ApiInfo; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.example.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Spring Boot中使用Swagger2构建RESTful APIs") .description("更多请关注相关问题") .termsOfServiceUrl("http://example.com") .version("1.0") .build(); } } ``` ### 常见问题 - 如果访问 `swagger-ui/index.html` 时出现空白页面,可以检查是否缺少 `swagger-models` 依赖,或者是否版本不兼容。 - 确保没有其他静态资源文件冲突,尤其是 `index.html` 文件。 - 如果使用的是 Spring Boot 2.x 以上版本,建议使用 Swagger 3.x 的依赖[^4]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值