https://github.com/deivu/uzuki
A RESTful API for @kancolle/data (Kancolle)
https://github.com/deivu/uzuki
kancolle rest shipgirls waifu
Last synced: about 2 months ago
JSON representation
A RESTful API for @kancolle/data (Kancolle)
- Host: GitHub
- URL: https://github.com/deivu/uzuki
- Owner: Deivu
- License: mit
- Created: 2020-10-01T03:32:11.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-07T06:47:06.000Z (over 4 years ago)
- Last Synced: 2025-03-11T07:25:57.876Z (7 months ago)
- Topics: kancolle, rest, shipgirls, waifu
- Language: Java
- Homepage:
- Size: 29.3 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Uzuki
The ShipGirl Project, Uzuki; `(c) Kancolle`
> Based on my earlier project [Hiei](https://github.com/Deivu/Hiei)
## Features
✅ Easy to use
✅ Configurable
✅ Rest based API
✅ Automatic Updates
## Downloads
🔗 https://github.com/Deivu/Uzuki/releases
## Support
🔗 https://discord.com/invite/FVqbtGu (#development)
Ping or ask for @Sāya#0113
## How to host
> Download the latest version from [Github Releases](https://github.com/Deivu/Uzuki/releases)
> Copy a config from [examples](https://github.com/Deivu/Uzuki/tree/master/example) folder
> Run the server by doing `java -jar uzuki.jar`
## Rest Client Example
> Node.JS (Javascript)
```js
const Fetch = require('node-fetch');
class Kancolle {
constructor() {
this.baseURL = 'http://localhost:1024';
this.auth = '1234';
}
searchShip(ship) {
return this._fetch('/ship/search', ship);
}
_fetch(endpoint, q) {
const url = new URL(endpoint, this.baseURL);
url.search = new URLSearchParams({ q }).toString();
return Fetch(url.toString(), { headers: { 'authorization': this.auth } })
.then(data => data.json());
}
}
const client = new Kancolle();
client.searchShip('uzuki')
.then(data => data.json())
.then(data => console.log(data));
```
> Made with ❤ by @Sāya#0113