Skip to content

bfirsh/docker-api-reference

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

74 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A better Docker Remote API reference

A work in progress. It produces this: https://bfirsh.github.io/docker-api-reference/

See docker/engine-api#77 for background.

Note: swagger.yaml is now in docker/docker, which is now the source of truth. For the current state of implementing the docs, see this pull request.

Usage

Install Dobi, the build tool:

curl -L -o /usr/local/bin/dobi "https://github.com/dnephin/dobi/releases/download/v0.8/dobi-$(uname -s)"; chmod +x /usr/local/bin/dobi

To view docs, run dobi preview and go to http://localhost

To validate the Swagger configuration, run dobi validate.

To generate a swagger.json file, run dobi swagger.json.

About

WIP: Better API reference for Docker, built on Swagger

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages