LogoLogo
  • About
  • Installation
  • Update & migration
  • Configuration
    • Hostname
    • TLS / HTTPS
    • Database
    • Logging
    • API Security
    • Storage
      • Disk
      • In-memory
      • S3
    • RTMP
    • SRT
    • FFmpeg
    • Sessions
    • Metrics
    • Router
    • Debug
  • API Swagger-Documentation
  • API Clients
  • Web-Interface
  • Guides
    • Beginner
    • RTMP
    • SRT
    • Filesystems
  • General
    • Prometheus metrics
  • API
    • Login
    • Config
    • Log
    • Filesystem
      • Disk
      • In-memory
      • S3
    • Metrics
    • Sessions
    • Profiling
    • Ping
  • API / FFmpeg
    • Process
      • Command
      • Metadata
      • State
      • Probe
      • Report
    • Skills
    • Widget (Website)
  • API / RTMP
    • RTMP
  • API / SRT
    • SRT
  • Development
    • Architecture
    • Coding
    • Custom Docker images
    • Benchmark
    • Support
Powered by GitBook
On this page

Was this helpful?

Export as PDF

API Swagger-Documentation

Swagger documentation.

PreviousDebugNextAPI Clients

Last updated 2 years ago

Was this helpful?

The documentation of the API is available on /api/swagger/index.html

Example:

docker run -d --name core -p 8080:8080 datarhei/core:latest

Open:

To generate the API documentation from the code, use :

make init swagger
make run

After the first command the swagger definition can be found at docs/swagger.json or docs/swagger.yaml.

The second command will build the core binary and start it. With the default configuration, the Swagger UI is available at http://localhost:8080/api/swagger/index.html.

Public demo:

http://127.0.0.1:8080/api/swagger/index.html
swag
Swagger UI
Logo