Sharkey/src/server/api/openapi/description.ts

58 lines
4.3 KiB
TypeScript
Raw Normal View History

2019-02-23 21:08:08 +02:00
export const description = `
## Usage
2019-02-23 21:11:54 +02:00
**APIはすべてPOSTでリクエスト/JSON形式です**
2019-02-23 21:08:08 +02:00
APIは認証情報()\`i\`というパラメータでアクセストークンを添付してください。
2019-02-23 21:11:54 +02:00
###
2019-02-23 21:08:08 +02:00
> API
> ()
###
APIを利用する際にはMisskeyに発行してもらいます
#### 1.
Webサービス()Misskeyに登録します
[](/dev) >
:
| | |
|---|---|
| | |
| | |
| URL | URLを設定できますWebサービスである場合に有用です |
| | APIからアクセスできます |
使
> </p>
#### 2.
使
%API_URL%/auth/session/generate appSecret
JSONでPOSTです
URLが取得できるのでURLをブラウザで表示し
URLを設定している場合
URLに token
URLを設定していない場合(())
#### 3.
%API_URL%/auth/session/userkey :
| | | |
|---|---|---|
| appSecret | string | |
| token | string | |
+sha256したものAPIにリクエストできます
:
<pre><code>const i = sha256(userToken + secretKey);</code></pre>
`;