Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/icewhaletech/icewhale-openapi
OpenAPI and API Document of ZimaOS and CasaOS
https://github.com/icewhaletech/icewhale-openapi
casaos openapi sdk zimaos
Last synced: 7 days ago
JSON representation
OpenAPI and API Document of ZimaOS and CasaOS
- Host: GitHub
- URL: https://github.com/icewhaletech/icewhale-openapi
- Owner: IceWhaleTech
- Created: 2023-06-02T22:53:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-24T08:22:12.000Z (23 days ago)
- Last Synced: 2024-10-25T06:28:09.135Z (22 days ago)
- Topics: casaos, openapi, sdk, zimaos
- Language: HTML
- Homepage: https://casaos.zimaspace.com
- Size: 171 KB
- Stars: 1
- Watchers: 7
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# IceWhale-OpenAPI
This Git repository is all IceWhale's OpenAPI Documentation. including:
- [CasaOS](https://github.com/IceWhaleTech/CasaOS)
- [ZimaOS](https://github.com/IceWhaleTech/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](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos/zimaos/openapi.yaml): Miscellaneous APIs, GPU, Remote Access, etc.
- [ZimaOS API V1](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos/zimaos/openapi_v1.yaml): Miscellaneous APIs, System APIs
- [ZimaOS Local Storage API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos-local-storage/local_storage/openapi.yaml): Disk and RAID, etc. APIs
- [ZimaOS Local Storage API V1](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos-local-storage/local_storage/openapi_v1.yaml): USB Mount about APIs.
- [APP Management API V2](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos-app-management/app_management/openapi.yaml): App and AppStore APIs: Docker Compose and App Store
- [APP Management API V1](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos-app-management/app_management/openapi_v1.yaml): App and AppStore APIs: Docker Container(Deprecated)
- [User API V2](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos-user-service/users/openapi.yaml): User APIs: Samba, etc.
- [User API V1](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos-user-service/users/openapi_v1.yaml): User APIs: Login, Register, etc.
- [ZimaOS File API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/icewhale-files/openapi.yaml): File APIs
- [Installer API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/casaos-installer/installer/openapi.yaml): OTA APIs
- [Mod Management API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos-mod-management/mod_management/openapi.yaml): Mod APIs
- [ZVM(Virtual Machine) API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos-virt-management/virt_management/openapi.yaml): Virtual Machine APIs
- [Message Bus API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/casaos-message-bus/message_bus/openapi.yaml): Message Bus APIs
# CasaOS OpenAPI Live Preview
- [CasaOS API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/casaos/casaos/openapi.yaml): Miscellaneous APIs and File APIs
- [APP Management API V2](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/casaos-app-management/app_management/openapi.yaml): App and AppStore APIs
- [APP Management API V1](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/casaos-app-management/app_management/openapi_v1.yaml): App and AppStore APIs
- [User API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/casaos-user-service/users/openapi.yaml): User APIs
- [Message Bus API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/casaos-message-bus/message_bus/openapi.yaml): Message Bus APIs
# How to use
## Use in Javascript/Typescript
you can find npm package in [npmjs.com](https://www.npmjs.com/settings/icewhale/packages)
such as:
```
npm install @icewhale/zimaos-localstorage-openapi
```
```typescript
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
//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
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.