137 lines
3.5 KiB
Markdown
137 lines
3.5 KiB
Markdown
このリポジトリは[uwuzu](https://github.com/Daichimarukana/uwuzu)を改変したものです。
|
|
以下の変更点が含まれます。
|
|
実機テストをしていないため全て実質エアプです()
|
|
バグなどがありましたら1.6.5と見合わせて実装お願いします
|
|
|
|
```
|
|
---
|
|
title: APIドキュメントを内蔵する
|
|
labels: feature
|
|
---
|
|
|
|
## 概要
|
|
現在のuwuzuではdocs.uwuzu.comによる簡易的なAPIドキュメントが使用されています。
|
|
しかしScalar+OpenAPIを使用することで分かりやすいドキュメントが作成できます。
|
|
|
|
### 目的
|
|
- 内蔵することで今後バージョンアップしてもサーバーのバージョンのドキュメントが見れる
|
|
- 論理に強い
|
|
|
|
### イメージ
|
|
1. ユーザーがログイン状態で/api-docsにアクセスします
|
|
2. ロード画面が表示されます(Iconify+生CSS)
|
|
3. ロードされた後ScalarによるAPIドキュメントが表示されます
|
|
|
|
### 誰が実装する？
|
|
- 私に任せてください。
|
|
|
|
### コードはどのように送る？(上記で「私に任せてください。」を選んだ方)
|
|
このリポジトリ
|
|
|
|
---
|
|
```
|
|
|
|
```
|
|
---
|
|
title: APIのHTTPステータスコードを200以外に対応させる
|
|
labels: feature
|
|
---
|
|
|
|
## 概要
|
|
/api以下では200以外のHTTPステータスコードも使用する。
|
|
|
|
### 目的
|
|
- 初見でもHTTPステータスコードで直感的にエラー内容がわかる
|
|
|
|
### イメージ
|
|
1. /api/me/?token=nasiにアクセスします
|
|
2. HTTP403が返ってきます
|
|
|
|
### 誰が実装する？
|
|
- 私に任せてください。
|
|
|
|
### コードはどのように送る？(上記で「私に任せてください。」を選んだ方)
|
|
このリポジトリ
|
|
|
|
---
|
|
```
|
|
|
|
```
|
|
---
|
|
title: APIの認証方法をBearerにする
|
|
labels: feature
|
|
---
|
|
|
|
## 概要
|
|
APIの認証方法をAuthorizationヘッダーのBearer Authに変更する
|
|
従来の方法も残す
|
|
|
|
### 目的
|
|
OpenAPIに対応させるため
|
|
|
|
### イメージ
|
|
1. Authorizationヘッダー、tokenクエリパラメータ、token(body)全てで認証できるようにする
|
|
|
|
### 誰が実装する？
|
|
- 私に任せてください。
|
|
|
|
### コードはどのように送る？(上記で「私に任せてください。」を選んだ方)
|
|
このリポジトリ
|
|
|
|
---
|
|
```
|
|
|
|
```
|
|
---
|
|
title: APIで404や503をJSONで返す
|
|
labels: feature
|
|
---
|
|
|
|
## 概要
|
|
APIでは404や503などがHTMLで返りJSONを想定したコードではエラーが発生します。
|
|
専用のJSONで返すことで対策ができます。
|
|
|
|
### 目的
|
|
- JSONに統一させるため
|
|
|
|
### イメージ
|
|
1. /api/noneにアクセスします
|
|
2. /errorpage/notfound.jsonが表示されます
|
|
|
|
### 誰が実装する？
|
|
- 私に任せてください。
|
|
|
|
### コードはどのように送る？(上記で「私に任せてください。」を選んだ方)
|
|
このリポジトリ
|
|
|
|
---
|
|
```
|
|
|
|
```
|
|
---
|
|
title: /api/token/inquiryを作成する
|
|
labels: feature
|
|
---
|
|
|
|
## 概要
|
|
/api/token/inquiryでAPIトークンから権限やユーザーIDを照会できます。
|
|
|
|
### 目的
|
|
パラメータから権限を変更しユーザー認可を承認する悪質な方法が取られる可能性を下げるため
|
|
|
|
### イメージ
|
|
1. /api/token/inquiry?token=TESTTOKENにアクセスします
|
|
2. 権限を配列で確認できます
|
|
|
|
### 誰が実装する？
|
|
- 私に任せてください。
|
|
|
|
### コードはどのように送る？(上記で「私に任せてください。」を選んだ方)
|
|
このリポジトリ
|
|
|
|
---
|
|
```
|
|
|
|
```
|
|
authcode/license.txtの誤字を修正
|
|
``` |