{ "openapi": "3.0.0", "info": { "title": "Shlink", "description": "Shlink, the self-hosted URL shortener", "version": "1.0" }, "servers": [ { "url": "{schema}://{server}/rest", "variables": { "schema": { "default": "https", "enum": ["https", "http"] }, "server": { "default": "" } } } ], "components": { "securitySchemes": { "Bearer": { "description": "The JWT identifying a previously logged API key", "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "tags": [ { "name": "Authentication", "description": "Authentication-related endpoints" }, { "name": "Short URLs", "description": "Operations that can be performed on short URLs" }, { "name": "Tags", "description": "Let you handle the list of available tags" }, { "name": "Visits", "description": "Operations to manage visits on short URLs" } ], "paths": { "/v1/authenticate": { "$ref": "paths/v1_authenticate.json" }, "/v1/short-urls": { "$ref": "paths/v1_short-urls.json" }, "/v1/short-urls/shorten": { "$ref": "paths/v1_short-urls_shorten.json" }, "/v1/short-urls/{shortCode}": { "$ref": "paths/v1_short-urls_{shortCode}.json" }, "/v1/short-urls/{shortCode}/tags": { "$ref": "paths/v1_short-urls_{shortCode}_tags.json" }, "/v1/tags": { "$ref": "paths/v1_tags.json" }, "/v1/short-urls/{shortCode}/visits": { "$ref": "paths/v1_short-urls_{shortCode}_visits.json" } } }