Refactor API (#4770)

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* Update description.ts

* wip
This commit is contained in:
syuilo 2019-04-23 22:35:26 +09:00 committed by GitHub
parent f31f986d66
commit 0463c6bb0f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
105 changed files with 1622 additions and 808 deletions

View file

@ -44,20 +44,20 @@ export function getDescription(lang = 'ja-JP'): string {
const descriptions = {
'ja-JP': `**Misskey is a decentralized microblogging platform.**
## Usage
# Usage
**APIはすべてPOSTでリクエスト/JSON形式です**
APIはリクエストに認証情報(APIキー)\`i\`というパラメータでAPIキーを添付してください。
### APIキーを取得する
## APIキーを取得する
> APIAPIキーを取得できます
> ()
### APIキーを取得する
## APIキーを取得する
APIキーをアプリケーションが扱うのはセキュリティ上のリスクがあるので
APIを利用する際にはAPIキーを発行します
#### 1.
### 1.
Webサービス()Misskeyに登録します
[](/dev) >
@ -65,7 +65,7 @@ export function getDescription(lang = 'ja-JP'): string {
> </p>
#### 2.
### 2.
使
[${config.apiUrl}/auth/session/generate](#operation/auth/session/generate) \`appSecret\`としてシークレットキーを含めたリクエストを送信します。
@ -76,7 +76,7 @@ export function getDescription(lang = 'ja-JP'): string {
URLを設定していない場合(())
#### 3.
### 3.
[${config.apiUrl}/auth/session/userkey](#operation/auth/session/userkey)
@ -88,7 +88,7 @@ APIキーの生成方法を擬似コードで表すと次のようになりま
const i = sha256(userToken + secretKey);
\`\`\`
## Permissions
# Permissions
|Permisson (kind)|Description|Endpoints|
|:--|:--|:--|
${permissionTable}