SwaggerSloop 1.0.0

🎨 SwaggerSloop

<p align="center"> <img src="docs/images/logo.svg" alt="SwaggerSloop Logo" width="120" height="120"> </p>

<p align="center"> <strong>A beautiful Swagger UI skin for .NET and Java</strong><br> <strong>美观的 Swagger UI 皮肤，支持 .NET 和 Java</strong> </p>

<p align="center"> <a href="#-features--特性">Features</a> • <a href="#-installation--安装">Installation</a> • <a href="#-quick-start--快速开始">Quick Start</a> • <a href="#%EF%B8%8F-configuration--配置">Configuration</a> • <a href="#-license--许可证">License</a> </p>

<p align="center"> <a href="https://www.nuget.org/packages/SwaggerSloop"><img src="https://img.shields.io/nuget/v/SwaggerSloop?logo=nuget&label=NuGet" alt="NuGet"></a> <a href="https://central.sonatype.com/artifact/com.seacode/swagger-sloop-spring-boot-starter"><img src="https://img.shields.io/maven-central/v/com.seacode/swagger-sloop-spring-boot-starter?logo=apachemaven&label=Maven" alt="Maven Central"></a> <img src="https://img.shields.io/badge/.NET-6.0%20%7C%207.0%20%7C%208.0%20%7C%209.0-512BD4?logo=dotnet" alt=".NET"> <img src="https://img.shields.io/badge/Java-8%2B-orange?logo=openjdk" alt="Java"> <img src="https://img.shields.io/badge/License-MIT-blue" alt="License"> </p>

<p align="center"> <a href="#english">English</a> | <a href="#中文">中文</a> </p>

<a id="english"></a>

English

✨ Features / 特性

📦 Installation / 安装

.NET

dotnet add package SwaggerSloop

Java (Maven)

<dependency>
    <groupId>com.seacode</groupId>
    <artifactId>swagger-sloop-spring-boot-starter</artifactId>
    <version>1.0.0</version>
</dependency>

Java (Gradle)

implementation 'com.seacode:swagger-sloop-spring-boot-starter:1.0.0'

🚀 Quick Start / 快速开始

.NET

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();
app.UseSwagger();
app.UseSwaggerSloop(); // 👈 Replace UseSwaggerUI()
app.Run();

Java (Spring Boot)

# application.properties
swagger-sloop.enabled=true
swagger-sloop.document-title=My API

Then visit: http://localhost:8080/swagger/

⚙️ Configuration / 配置

.NET

app.UseSwaggerSloop(options =>
{
    options.DocumentTitle = "My API";
    options.RoutePrefix = "swagger";
    options.PrimaryColor = "#5D87FF";
    options.DefaultTheme = "auto"; // light, dark, auto
    options.EnableSearch = true;
    options.EnableCodeCopy = true;
});

Java

# application.yml
swagger-sloop:
  enabled: true
  document-title: My API
  route-prefix: swagger
  primary-color: "#5D87FF"
  default-theme: auto
  enable-search: true
  enable-code-copy: true
  swagger-endpoints:
    - url: /v3/api-docs
      name: API V1

⌨️ Keyboard Shortcuts

<a id="中文"></a>

中文

✨ 特性

📦 安装

.NET

dotnet add package SwaggerSloop

Java (Maven)

<dependency>
    <groupId>com.seacode</groupId>
    <artifactId>swagger-sloop-spring-boot-starter</artifactId>
    <version>1.0.0</version>
</dependency>

🚀 快速开始

.NET

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();
app.UseSwagger();
app.UseSwaggerSloop(); // 👈 替换 UseSwaggerUI()
app.Run();

Java (Spring Boot)

# application.properties
swagger-sloop.enabled=true
swagger-sloop.document-title=我的 API

然后访问：http://localhost:8080/swagger/

⚙️ 配置项

⌨️ 快捷键

📁 Project Structure / 项目结构

SwaggerSloop/
├── dotnet/                              # .NET 实现
│   ├── src/SwaggerSloop/                # 主库
│   └── samples/SwaggerSloop.Sample/     # 示例
├── java/                                # Java 实现
│   ├── swagger-sloop-spring-boot-starter/  # Spring Boot Starter
│   └── samples/swagger-sloop-sample/    # 示例
└── shared/resources/                    # 共享前端资源

📄 License / 许可证

MIT License

🙏 Credits / 致谢

• UI inspired by Art-Design-Pro
• Features inspired by knife4j

<p align="center"> Made with ❤️ by <a href="https://github.com/seacode">SeaCode</a> </p>