Improve doc

This commit is contained in:
syuilo 2019-02-24 12:40:17 +09:00
parent 57009057ae
commit b8e0ec9edc
No known key found for this signature in database
GPG Key ID: BDC4C49D06AB9D69
4 changed files with 30 additions and 23 deletions

View File

@ -13,7 +13,11 @@ export const meta = {
params: { params: {
appSecret: { appSecret: {
validator: $.str validator: $.str,
desc: {
'ja-JP': 'アプリケーションのシークレットキー',
'en-US': 'The secret key of your application.'
}
} }
}, },

View File

@ -10,7 +10,11 @@ export const meta = {
params: { params: {
token: { token: {
validator: $.str validator: $.str,
desc: {
'ja-JP': 'セッションのトークン',
'en-US': 'The token of a session.'
}
} }
}, },

View File

@ -13,11 +13,19 @@ export const meta = {
params: { params: {
appSecret: { appSecret: {
validator: $.str validator: $.str,
desc: {
'ja-JP': 'アプリケーションのシークレットキー',
'en-US': 'The secret key of your application.'
}
}, },
token: { token: {
validator: $.str validator: $.str,
desc: {
'ja-JP': 'セッションのトークン',
'en-US': 'The token of a session.'
}
} }
}, },

View File

@ -1,3 +1,5 @@
import config from '../../../config';
export const description = ` export const description = `
## Usage ## Usage
**APIはすべてPOSTでリクエスト/JSON形式です** **APIはすべてPOSTでリクエスト/JSON形式です**
@ -9,20 +11,12 @@ export const description = `
> () > ()
### ###
APIを利用する際にはMisskeyに発行してもらいます APIを利用する際にはMisskeyに発行してもらいます
#### 1. #### 1.
Webサービス()Misskeyに登録します Webサービス()Misskeyに登録します
[](/dev) > [](/dev) >
:
| | |
|---|---|
| | |
| | |
| URL | URLを設定できますWebサービスである場合に有用です |
| | APIからアクセスできます |
使 使
@ -31,27 +25,24 @@ export const description = `
#### 2. #### 2.
使 使
%API_URL%/auth/session/generate appSecret [${config.api_url}/auth/session/generate](#operation/auth/session/generate) appSecret
JSONでPOSTです JSONでPOSTです
URLが取得できるのでURLをブラウザで表示し URLが取得できるのでURLをブラウザで表示し
URLを設定している場合 URLを設定している場合
URLに token URLに\`token\`という名前でセッションのトークンが含まれたクエリを付けてリダイレクトします。
URLを設定していない場合(()) URLを設定していない場合(())
#### 3. #### 3.
%API_URL%/auth/session/userkey : [${config.api_url}/auth/session/userkey](#operation/auth/session/userkey)
| | | |
|---|---|---|
| appSecret | string | |
| token | string | |
+sha256したものAPIにリクエストできます *+sha256したもの*APIにリクエストできます
: :
<pre><code>const i = sha256(userToken + secretKey);</code></pre> \`\`\` js
const i = sha256(userToken + secretKey);
\`\`\`
`; `;