rudeshark.net/src/server/api/openapi/description.ts

49 lines
3.7 KiB
TypeScript
Raw Normal View History

2019-02-24 04:40:17 +01:00
import config from '../../../config';
2019-02-23 20:08:08 +01:00
export const description = `
## Usage
2019-02-23 20:11:54 +01:00
**APIはすべてPOSTでリクエスト/JSON形式です**
2019-02-23 20:08:08 +01:00
APIは認証情報()\`i\`というパラメータでアクセストークンを添付してください。
2019-02-23 20:11:54 +01:00
###
2019-02-23 20:08:08 +01:00
> API
> ()
###
2019-02-24 04:40:17 +01:00
2019-02-23 20:08:08 +01:00
APIを利用する際にはMisskeyに発行してもらいます
#### 1.
Webサービス()Misskeyに登録します
[](/dev) >
使
> </p>
#### 2.
使
2019-02-24 04:53:22 +01:00
[${config.apiUrl}/auth/session/generate](#operation/auth/session/generate) appSecret
2019-02-23 20:08:08 +01:00
JSONでPOSTです
URLが取得できるのでURLをブラウザで表示し
URLを設定している場合
2019-02-24 04:40:17 +01:00
URLに\`token\`という名前でセッションのトークンが含まれたクエリを付けてリダイレクトします。
2019-02-23 20:08:08 +01:00
URLを設定していない場合(())
#### 3.
2019-02-24 04:53:22 +01:00
[${config.apiUrl}/auth/session/userkey](#operation/auth/session/userkey)
2019-02-23 20:08:08 +01:00
2019-02-24 04:40:17 +01:00
*+sha256したもの*APIにリクエストできます
2019-02-23 20:08:08 +01:00
:
2019-02-24 04:40:17 +01:00
\`\`\` js
const i = sha256(userToken + secretKey);
\`\`\`
2019-02-23 20:08:08 +01:00
`;