#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

#17 in #stub

Download history 763/week @ 2024-01-05 6814/week @ 2024-01-12 9283/week @ 2024-01-19 10424/week @ 2024-01-26 8770/week @ 2024-02-02 10325/week @ 2024-02-09 9740/week @ 2024-02-16 9859/week @ 2024-02-23 7100/week @ 2024-03-01 8023/week @ 2024-03-08 9245/week @ 2024-03-15 8953/week @ 2024-03-22 7708/week @ 2024-03-29 5307/week @ 2024-04-05 7529/week @ 2024-04-12 6875/week @ 2024-04-19

29,546 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
~64K SLoC