https://github.com/vzsoares/openapi-swagger-portal

Awesome OpenAPI/Swagger documentation portal 🚀 • Easily display multiple swagger UI's 🤩
https://github.com/vzsoares/openapi-swagger-portal

documentation openapi swagger

Last synced: about 1 month ago
JSON representation

Awesome OpenAPI/Swagger documentation portal 🚀 • Easily display multiple swagger UI's 🤩

• Host: GitHub
• URL: https://github.com/vzsoares/openapi-swagger-portal
• Owner: vzsoares
• License: mit
• Created: 2025-03-08T00:59:28.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-08-02T00:46:03.000Z (11 months ago)
• Last Synced: 2025-08-02T02:40:21.945Z (11 months ago)
• Topics: documentation, openapi, swagger
• Language: JavaScript
• Homepage: https://vzsoares.github.io/openapi-swagger-portal/src
• Size: 259 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Minimalistic API Portal

![API Portal Preview](/static/preview.png)

A lightweight, minimalistic OpenAPI/Swagger documentation portal built with **Alpine.js**, **TailwindCSS**, and **Vite**.

Provides a clean interface for exploring and testing multiple API schemas (OpenAPI/Swagger) from different domains.

## Features

- 🚀 **Vite-Powered** – Fast development server & optimized build

- 📱 **Fully Responsive** – Works seamlessly on desktop, tablet, and mobile devices

- 🌐 **Multi-API Support** – Organize and display multiple APIs by domain category

- 🔎 **Interactive Documentation** – Powered by Swagger UI for testing API endpoints

- 🔄 **Deep Linking** – Share direct links to specific APIs and endpoints

- ⚡ **Lightweight** – Minimal dependencies and fast loading

## Usage

### Development

```bash

npm install

npm run dev

```

### Production Build

```bash

npm run build

npm run preview

```

Serve the `dist/` folder with any static server.

## Configuration

All configuration is now in **`src/config.json`**:

```json

{

    "siteName": "API Portal",

    "supportUrl": "https://example.com",

    "primaryColor": "#1e2939",

    "secondaryColor": "#193cb8",

    "schemas": [

        {

            "name": "Domain Name",

            "apis": [

                {

                    "name": "API Name",

                    "url": "https://path-to-your-swagger-definition.json"

                }

            ]

        }

    ]

}

```

Edit this file to set your portal name, colors, support link, and API definitions.

## Contributing

Contributions are welcome! Submit a Pull Request to improve features, styling, or documentation.

## License

MIT – See [LICENSE](LICENSE).

## Acknowledgments

- [Swagger UI](https://swagger.io/tools/swagger-ui/) – API documentation renderer

- [Alpine.js](https://alpinejs.dev/) – Lightweight reactivity system

- [TailwindCSS](https://tailwindcss.com/) – Utility-first CSS framework

- [Vite](https://vitejs.dev/) – Lightning-fast build tool

---

Made with ❤️ for API consumers and developers