shlink/docs/swagger/swagger.json

{
    "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"
            }
        }
    },

    "paths": {
        "/v1/authenticate": {
            "$ref": "paths/v1_authenticate.json"
        },

        "/v1/short-codes": {
            "$ref": "paths/v1_short-codes.json"
        },
        "/v1/short-codes/{shortCode}": {
            "$ref": "paths/v1_short-codes_{shortCode}.json"
        },
        "/v1/short-codes/{shortCode}/tags": {
            "$ref": "paths/v1_short-codes_{shortCode}_tags.json"
        },

        "/v1/tags": {
            "$ref": "paths/v1_tags.json"
        },

        "/v1/short-codes/{shortCode}/visits": {
            "$ref": "paths/v1_short-codes_{shortCode}_visits.json"
        }
    }
}