# README
Docker Swarm API README
The Docker Swarm API is mostly compatible with the Docker Remote
API. To read
the end-user API documentation, visit the Swarm API documentation on
docs.docker.com. If you want to
modify the discovery API documentation, start with the docs/swarm-api.md
file in this project.
# Functions
NewPrimary creates a new API router.
NewReplica creates a new API replica.
NewServer creates an api.Server.
NewWriteFlusher creates a new WriteFlusher for the writer.
# Constants
APIVERSION is the API version supported by swarm manager.
DefaultDockerPort is the default port to listen on for incoming connections.
# Structs
Replica is an API replica that reserves proxy to the primary.
Server is a Docker API server.
A WriteFlusher provides synchronized write access to the writer's underlying data stream and ensures that each write is flushed immediately.
# Interfaces
StatusHandler allows the API to display extra information on docker info.
# Type aliases
ContainerSorter implements the Sort interface to sort Docker containers.
ImageSorter implements the Sort interface to sort Docker Images.