Improve doc

This commit is contained in:
syuilo 2019-02-25 04:18:09 +09:00
parent 47d4dcfdf5
commit 60c9a6528f
No known key found for this signature in database
GPG key ID: BDC4C49D06AB9D69
14 changed files with 52 additions and 12 deletions

View file

@ -3,16 +3,16 @@ import config from '../../../config';
export const description = `
## Usage
**APIはすべてPOSTでリクエスト/JSON形式です**
APIは認証情報()\`i\`というパラメータでアクセストークンを添付してください。
APIはリクエストに認証情報(APIキー)\`i\`というパラメータでAPIキーを添付してください。
###
> API
### APIキーを取得す
> APIAPIキーを取得できま
> ()
###
APIを利用する際にはMisskeyに発行してもらいます
### APIキーを取得す
APIキーをアプリケーションが扱うのはセキュリティ上のリスクがあるの
APIを利用する際にはAPIキーを発行します
#### 1.
Webサービス()Misskeyに登録します
@ -25,8 +25,7 @@ export const description = `
#### 2.
使
[${config.apiUrl}/auth/session/generate](#operation/auth/session/generate) appSecret
JSONでPOSTです
[${config.apiUrl}/auth/session/generate](#operation/auth/session/generate) \`appSecret\`としてシークレットキーを含めたリクエストを送信します。
URLが取得できるのでURLをブラウザで表示し
URLを設定している場合
@ -34,14 +33,14 @@ export const description = `
URLを設定していない場合(())
#### 3.
#### 3.
[${config.apiUrl}/auth/session/userkey](#operation/auth/session/userkey)
*+sha256したもの*APIにリクエストできます
*+sha256したもの*APIキーとしAPIにリクエストできます
:
APIキーの生成方法を擬似コードで表すと次のようになりま:
\`\`\` js
const i = sha256(userToken + secretKey);
\`\`\`