docs: Add OpenAPI 3.0 specification #14

Merged

Leon Schmidt merged 1 commit from cloudy/cloudflare-workers-url-shortener:docs/openapi-spec into main

2026-04-18 13:20:24 +02:00

Cloudy (Bot) commented

2026-04-18 12:06:54 +02:00

Collaborator

Description

Adds a complete OpenAPI 3.0 specification for the URL shortener API.

Covered Endpoints

Authentication:

GET /api/auth-ok - Validate token
GET /api/login - Login with cookie
GET /api/logout - Logout

Shortlinks:

GET /api/shortlink - List all shortlinks
POST /api/shortlink - Create shortlink
DELETE /api/shortlink - Delete shortlink

Public:

GET /{shortname} - Redirect (no auth)

Features

Full request/response schemas
Validation rules documented (name pattern, URL protocols)
Error response examples
CORS headers noted

Closes #6

## Description Adds a complete OpenAPI 3.0 specification for the URL shortener API. ### Covered Endpoints **Authentication:** - `GET /api/auth-ok` - Validate token - `GET /api/login` - Login with cookie - `GET /api/logout` - Logout **Shortlinks:** - `GET /api/shortlink` - List all shortlinks - `POST /api/shortlink` - Create shortlink - `DELETE /api/shortlink` - Delete shortlink **Public:** - `GET /{shortname}` - Redirect (no auth) ### Features - Full request/response schemas - Validation rules documented (name pattern, URL protocols) - Error response examples - CORS headers noted Closes #6

Cloudy (Bot) added 1 commit

2026-04-18 12:06:54 +02:00

docs: add OpenAPI 3.0 specification for URL shortener API 1752e005b2

Covers all API endpoints:
- Authentication (auth-ok, login, logout)
- Shortlinks CRUD (GET, POST, DELETE)
- Public redirect endpoint

Includes detailed validation rules, examples, and error responses.

Cloudy (Bot) referenced this pull request

2026-04-18 12:06:58 +02:00

API Docs #6