Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/himenon/docker-typescript-openapi
TypeScript implementations generated from Docker OpenAPI
https://github.com/himenon/docker-typescript-openapi
docker nodejs openapi swagger typescript
Last synced: 12 days ago
JSON representation
TypeScript implementations generated from Docker OpenAPI
- Host: GitHub
- URL: https://github.com/himenon/docker-typescript-openapi
- Owner: Himenon
- License: mit
- Created: 2022-03-08T11:41:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-03-09T06:40:47.000Z (over 2 years ago)
- Last Synced: 2024-10-11T20:59:03.253Z (about 1 month ago)
- Topics: docker, nodejs, openapi, swagger, typescript
- Language: TypeScript
- Homepage:
- Size: 141 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# @himenon/docker-typescript-openapi
```bash
yarn add @himenon/docker-typescript-openapi
```
## Usage
### Get Docker Image
[Example Code](example/get-docker-images.ts)
```ts
import { Client } from "@himenon/docker-typescript-openapi/v1.41";
import * as ApiClientImpl from "@himenon/docker-typescript-openapi/api-client-impl";
import * as fs from "fs";
const main = async () => {
const apiClientImpl = ApiClientImpl.create({
socketPath: "/var/run/docker.sock",
});
const client = new Client(apiClientImpl, "/v1.41");
fs.mkdirSync("debug", { recursive: true });
const filename1 = "debug/docker-images.json";
const imageList = await client.ImageList({
parameter: {},
});
fs.writeFileSync(filename1, JSON.stringify(imageList, null, 2), "utf-8");
console.log(`Output: ${filename1}`);
const filename2 = "debug/docker-containers.json";
const containerList = await client.ContainerList({
parameter: {},
});
fs.writeFileSync(filename2, JSON.stringify(containerList, null, 2), "utf-8");
console.log(`Output: ${filename2}`);
};
main();
```
### Output Logs
[Example Code](example/get-container-log.ts)
```ts
import { Client } from "@himenon/docker-typescript-openapi/v1.41";
import * as ApiClientImpl from "@himenon/docker-typescript-openapi/api-client-impl";
import * as fs from "fs";
import * as path from "path";
import * as stream from "stream";
const main = async () => {
const apiClientImpl = ApiClientImpl.create({
socketPath: "/var/run/docker.sock",
});
const client = new Client(apiClientImpl, "/v1.41");
fs.mkdirSync("debug", { recursive: true });
const currentDir = path.resolve("example");
const containerName = "create-from-api";
const alreadyUsedContainers = await client.ContainerList({
parameter: {
all: true,
filters: `name=${containerName}`,
},
});
const removeTasks = alreadyUsedContainers.map(async container => {
if (!container.Id) {
return;
}
if (container.State === "running") {
await client.ContainerStop({
parameter: {
id: container.Id,
},
});
}
await client.ContainerDelete({
parameter: {
id: container.Id,
},
});
});
await Promise.all(removeTasks);
const filename1 = "debug/docker-create-container.json";
const container = await client.ContainerCreate({
headers: {
"Content-Type": "application/json",
},
parameter: {
name: containerName,
},
requestBody: {
Image: "golang:1.17",
WorkingDir: "/app",
AttachStdin: true,
AttachStdout: true,
AttachStderr: true,
OpenStdin: true,
Cmd: ["ls"],
HostConfig: {
Mounts: [
{
Type: "bind",
Source: currentDir,
Target: "/app",
},
],
},
},
});
fs.writeFileSync(filename1, JSON.stringify(container, null, 2), "utf-8");
console.log(`Output: ${filename1}`);
await client.ContainerStart({
parameter: {
id: container.Id,
},
});
const logStream = new stream.PassThrough();
logStream.on("data", chunk => {
console.log(chunk.toString("utf-8"));
});
await client.ContainerLogs(
{
headers: {
Accept: "application/json",
},
parameter: {
id: container.Id,
stdout: true,
stderr: true,
follow: true,
tail: "all",
},
},
{
isStream: true,
onResponse: res => {
res.on("data", chunks => {
logStream.write(chunks);
});
res.on("end", () => {
logStream.end();
});
},
},
);
};
main().catch(error => {
console.error(error);
process.exit(1);
});
```
## Build
```ts
yarn run build
```
## OpenAPI Source for Docker
-
## OpenAPI TypeScript Code Generator
- [@himenon/openapi-typescript-code-generator](https://github.com/Himenon/openapi-typescript-code-generator)
You can also just use the type definition
## Use Another Version
Edit [config.ts](./scripts/config.ts)
## Debugging
Docker Engine Logs
**Mac OS**
```bash
tail -f ~/Library/Containers/com.docker.docker/Data/log/host/com.docker.driver.amd64-linux.log
```
## LICENCE
[@Himenon/docker-typescript-openapi](https://github.com/Himenon/docker-typescript-openapi)・MIT
## Inspired By
- https://github.com/apocas/dockerode
- https://github.com/apocas/docker-modem