Skip to content
@Swaggy-Swagger

Swaggy-Swagger

Swaggy Swagger



Swaggy-Swagger-Logo

Swaggy Swagger


Jitpack Release License Fossa License Scan FOSSA Status github release github last release date
github contributors github stars github discussions



English | 한국어

Overview

Swaggy-Swagger is a library designed to enhance the functionality and user experience of the popular API documentation tool, Swagger.

This project addresses common pain points faced by developers, improving the Swagger UI and adding new features to make API documentation more intuitive and effective.

Demo Website

swaggy-swagger.vercel.app

Demo Video

Features

Enhanced UI/UX

Sidebar Navigation

  • A new sidebar allows for quick navigation to specific API sections, improving accessibility and ease of use.

Image 1 Image 2

Horizontal Layout

  • The default vertical layout has been changed to a horizontal format, enabling easier viewing of parameters and responses, and reducing the need for scrolling.

    스크린샷 2024-08-28 오후 11 24 29

Change Tracking and Visualization

  • Server-Side Change Management: Every server restart triggers the storage of Swagger snapshots in JSON format. These snapshots are versioned, and changes are logged.

  • Client-Side Change Indicators: APIs with recent changes are marked with a red dot. Hovering over the API reveals information about the changes (e.g. endpoints, parameters, request/response schemas)

    스크린샷 2024-08-28 오후 10 54 36 스크린샷 2024-08-28 오후 10 54 12

  • After checking changes, the red dot disappears (it reappears upon refreshing)

API Sorting By Line Number

  • User-Defined Sorting: Swaggy-Swagger allows APIs to be sorted based on the line numbers in the code. This custom sorting improves readability and reflects the developer’s intent.

Enjoy Swaggy Swagger 😎

스크린샷 2024-08-28 오후 10 54 36 스크린샷 2024-08-28 오후 10 54 12

How to Use

Ways to contribute

We always welcome your contributions!

  • If you would like to contribute to the frontend (UI), you can see swaggy-ui for more details.

  • Else, if you want to contribute to the backend (server-side), please refer to CONTRIBUTING.md.

Contributors

Thank you to everyone who contributed to our project.

Made with contrib.rocks

License

Swaggy-Swagger is licensed under the Apache License, Version 2.0.
See the LICENSE file for more details.

FOSSA Status

Contact

Pinned Loading

  1. swagger-custom-java swagger-custom-java Public

    swagger customization for java

    Java 32 1

  2. swaggy-ui swaggy-ui Public

    Forked from swagger-api/swagger-ui

    Swaggy-Swagger FE Repository for customizing Swagger

    JavaScript 18 3

Repositories

Showing 4 of 4 repositories

Top languages

Loading…

Most used topics

Loading…