# Shlink API Spec UI

Shlink API Spec UI is a Swagger-based web interface for browsing and testing Shlink's OpenAPI specifications, giving developers a visual way to explore and call the Shlink URL shortener's REST API. It is open source and self-hosted, installable on Docker Hub.

Canonical page: https://ourlocalhost.com/app/6154/shlink-api-spec-ui

## Description

Shlink API Spec UI is a Swagger-based web interface for browsing and testing Shlink's OpenAPI specifications, giving developers a visual way to explore and call the Shlink URL shortener's REST API.

## Platform availability

Available on 0 of 10 platforms.

## Health score

56/100 (Fair), based on 3 of 4 factors.
- Maintained: 100 (last commit 5 days ago)
- Popular: 10 (2 GitHub stars)
- Easy to install: 25 (0 install platforms, install notes, Docker image)

## Links

- GitHub: https://github.com/shlinkio/shlink-api-spec-ui
- Docker Hub: https://hub.docker.com/r/shlinkio/shlink-api-spec-ui

## Common questions

### Is there a hosted UI for browsing Shlink's Open API specs?

Yes, a hosted Swagger UI is available for loading Shlink's Open API specs.

### What checks should I run if the spec UI cannot interact with Shlink?

Request the /rest/health endpoint to see if the service is alive. If it fails, the app is not reachable or running. You can also create a test short URL with POST /rest/v{version}/short-urls and open the shortened link.

### Is there an official Shlink web client that manages multiple instances?

There is an official Shlink web client that uses the REST API to handle multiple Shlink instances.

### Does Shlink expose a REST API in addition to a CLI?

Yes, Shlink provides both a REST and a CLI interface.

## Alternatives

- Beacons: Create a free, beautiful, and highly customizable link in bio website with Beacons.
- Dub.co: Open-source link management with analytics, free QR code generation, custom domains, advanced audience targeting, team collaboration, and S…
- Fli.so: Fli.so is a lightning-fast URL shortener built with SvelteKit and PocketBase.
- Polr: Like everything else here, Polr is an open source and self-hostable web application.
- Shlink: A self-hosted URL shortener application that lets you create and manage shortened links under your own domain, with both command-line and R…
- TinyURL: Converts long URLs into short, secure links, supports branded domains, bulk shortening via API, link analytics, QR code generation, and das…
- YOURLS: YOURLS is a free, open-source self-hosted URL shortener that lets you create shortened links on your own server, with analytics, plugins, a…
- bit.ly: Shortens URLs, generates customizable QR codes, tracks clicks, offers branded domains, bulk management, analytics, browser extension, and A…
- rs-short: Rs-short is a minimal, lightweight link shortener written in Rust for self-hosters who want a fast, private, resource-efficient URL shorten…

---
Source: Our Local Host (https://ourlocalhost.com/app/6154/shlink-api-spec-ui), the self-hosted and open-source app directory.
