forked from Roflin/gamenight
59 lines
1.8 KiB
Markdown
59 lines
1.8 KiB
Markdown
# Rust API client for openapi
|
|
|
|
Api specifaction for a Gamenight server
|
|
|
|
For more information, please visit [https://brentj.es](https://brentj.es)
|
|
|
|
## Overview
|
|
|
|
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
|
|
|
|
- API version: 1.0
|
|
- Package version: 1.0
|
|
- Generator version: 7.12.0
|
|
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`
|
|
|
|
## Installation
|
|
|
|
Put the package under your project folder in a directory named `openapi` and add the following to `Cargo.toml` under `[dependencies]`:
|
|
|
|
```
|
|
openapi = { path = "./openapi" }
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *http://localhost:8080*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*DefaultApi* | [**get_gamenight**](docs/DefaultApi.md#get_gamenight) | **GET** /gamenight |
|
|
*DefaultApi* | [**get_gamenights**](docs/DefaultApi.md#get_gamenights) | **GET** /gamenights | Your GET endpoint
|
|
*DefaultApi* | [**get_token**](docs/DefaultApi.md#get_token) | **GET** /token |
|
|
*DefaultApi* | [**post_gamenight**](docs/DefaultApi.md#post_gamenight) | **POST** /gamenight |
|
|
*DefaultApi* | [**post_register**](docs/DefaultApi.md#post_register) | **POST** /user |
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
- [AddGamenightRequestBody](docs/AddGamenightRequestBody.md)
|
|
- [Failure](docs/Failure.md)
|
|
- [Gamenight](docs/Gamenight.md)
|
|
- [GetGamenightRequest](docs/GetGamenightRequest.md)
|
|
- [GetToken401Response](docs/GetToken401Response.md)
|
|
- [Login](docs/Login.md)
|
|
- [Registration](docs/Registration.md)
|
|
- [Token](docs/Token.md)
|
|
|
|
|
|
To get access to the crate's generated documentation, use:
|
|
|
|
```
|
|
cargo doc --open
|
|
```
|
|
|
|
## Author
|
|
|
|
dennis@brentj.es
|
|
|