IceWhale-OpenAPI

This Git repository is all IceWhale's OpenAPI Documentation. including:

• CasaOS
• ZimaOS

API V2 is our latest API, but it not contain all API. some operation is in V1 yet.

ZimaOS OpenAPI Live Preview

• ZimaOS API V2: Miscellaneous APIs, GPU, Remote Access, etc.
• ZimaOS API V1: Miscellaneous APIs, System APIs
• ZimaOS Local Storage API: Disk and RAID, etc. APIs
• ZimaOS Local Storage API V1: USB Mount about APIs.
• APP Management API V2: App and AppStore APIs: Docker Compose and App Store
• APP Management API V1: App and AppStore APIs: Docker Container(Deprecated)
• User API V2: User APIs: Samba, etc.
• User API V1: User APIs: Login, Register, etc.
• ZimaOS File API: File APIs
• Installer API: OTA APIs
• Mod Management API: Mod APIs
• ZVM(Virtual Machine) API: Virtual Machine APIs
• Message Bus API: Message Bus APIs

CasaOS OpenAPI Live Preview

• CasaOS API: Miscellaneous APIs and File APIs
• APP Management API V2: App and AppStore APIs
• APP Management API V1: App and AppStore APIs
• User API: User APIs
• Message Bus API: Message Bus APIs

How to use

Use in Javascript/Typescript

you can find npm package in npmjs.com such as:

npm install @icewhale/zimaos-localstorage-openapi

import { StorageMethodsApi } from '@icewhale/zimaos-localstorage-openapi'
...
export const storageApi = new StorageMethodsApi(configuration, '/v2/local_storage', axios)
...
storageApi.getDisk()

Golang

you can use the openapi.yaml file to generate the API code.

such as, add the following code to the header of your main.go file

//go:generate bash -c "mkdir -p codegen/local_storage && go run github.com/deepmap/oapi-codegen/cmd/[email protected] -generate types,client -package local_stroage https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos-local-storage/local_storage/openapi.yaml > codegen/local_storage/api.go"

then run the following command to generate the API code.

go generate

Other Language

you can use the openapi.yaml file to generate the API code.

Contributing

the repo is mirror of OpenAPI of IceWhale's project. if you want to modify the API, please go to the project's repo to modify.

License

MIT

Contact

Feel free to contact us by Issue.