Interactive Swagger UI & OpenAPI Specification

RUSEON Core automatically generates and serves interactive OpenAPI 3.0 documentation directly from its embedded HTTP server.

---

1. Accessing Swagger UI

Navigate to the Swagger UI endpoint in your web browser:

http://localhost:8080/swagger/index.html

Direct Specification URLs:

• JSON Format: http://localhost:8080/swagger/doc.json
• YAML Format: http://localhost:8080/swagger/doc.yaml

---

2. Authorizing Requests in Swagger UI

1. Click the green Authorize button at the top right of the Swagger UI.
2. Enter your JWT token in the value box with the Bearer prefix:

   Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

3. Click Authorize $\to$ Close.
4. All subsequent Try it out requests will automatically include the Authorization header.

---

3. Generating Client SDKs

Generate strongly-typed client libraries in any language using OpenAPI Generator:

# Generate TypeScript / Axios client
npx @openapitools/openapi-generator-cli generate \
  -i http://localhost:8080/swagger/doc.json \
  -g typescript-axios \
  -o ./src/api/ruseon-client

# Generate Python client
openapi-generator-cli generate \
  -i http://localhost:8080/swagger/doc.json \
  -g python \
  -o ./ruseon_python_sdk

Related Documentation

• API Overview
• REST API Reference
• Authentication API Guide
• Web UI Dashboard