#docker #stub #api #models

docker-api-stubs

Generated Docker API swagger stubs for use in docker-api

4 releases (breaking)

0.5.0 Feb 21, 2023
0.4.0 Oct 19, 2022
0.3.0 Aug 26, 2022
0.2.0 Aug 26, 2022
0.1.0 Jul 27, 2022

#16 in #stub

Download history 745/week @ 2023-12-04 857/week @ 2023-12-11 1035/week @ 2023-12-18 429/week @ 2023-12-25 460/week @ 2024-01-01 1568/week @ 2024-01-08 8377/week @ 2024-01-15 9817/week @ 2024-01-22 9990/week @ 2024-01-29 8785/week @ 2024-02-05 11467/week @ 2024-02-12 9216/week @ 2024-02-19 9355/week @ 2024-02-26 6301/week @ 2024-03-04 8982/week @ 2024-03-11 8307/week @ 2024-03-18

33,616 downloads per month
Used in 14 crates (via docker-api)

MIT license

325KB
4.5K SLoC

docker-api

GitHub Actions MIT licensed Released API docs

a rust interface to Docker containers

Install

Add the following to your Cargo.toml file

[dependencies]
docker-api = "0.14"

Supported API

Default endpoints include:

  • Containers
  • Images
  • Networks
  • Volumes
  • Exec
  • System

To enable swarm endpoints add a swarm feature to Cargo.toml like so:

docker-api = { version = "0.14", features = ["swarm"] }

Swarm endpoints include:

  • Swarm
  • Nodes
  • Services
  • Tasks
  • Secrets
  • Configs
  • Plugins

Latest stable version of this crate supports API version: v1.42 Master branch supports: v1.43

Features

SSL Connection

To enable HTTPS connection to docker add a tls flag to Cargo.toml.

Chrono

To enable chrono DateTime timestamps add a chrono feature flag to Cargo.toml.

Default features

By default only chrono feature is enabled. To disable it use:

docker-api = { version = "0.14", default-features = false }

Usage

Examples for most API endpoints can be found in the examples directory.

Notice

This crate is a fork of shiplift.

License

MIT

Dependencies

~2.2–3MB
~63K SLoC